Merge pull request #632 from jkloetzke/list-layers

List layers command

Author: jkloetzke

doc/conf.py

@@ -61,7 +61,7 @@ def __getattr__(cls, name):
 
 # General information about the project.
 project = 'Bob'
-copyright = '2016-2024, The BobBuildTool Contributors'
+copyright = '2016-2025, The BobBuildTool Contributors'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the

doc/manpages/bob-layers.rst

@@ -15,6 +15,9 @@ Synopsis
 
 ::
 
+    bob layers update [-h] [-lc LAYERCONFIG] [-D DEFINES]
+                      [--indent INDENT | --no-indent]
+                      [--format {yaml,json,flat}]
     bob layers status [-h] [-lc LAYERCONFIG] [-D DEFINES] [--show-clean]
                       [--show-overrides] [-v]
     bob layers update [-h] [-lc LAYERCONFIG] [-D DEFINES]
@@ -23,8 +26,12 @@ Synopsis
 Description
 -----------
 
-Update layers or show their SCM-status. The following sub-commands are
-available:
+Update layers or show their status. The following sub-commands are available:
+
+``ls``
+    List known layers and their properties. There are multiple output formats
+    available. The output of this command is supposed to stay stable and is
+    thus suitable for scripting.
 
 ``update``
     Updates the layers.
@@ -45,6 +52,20 @@ Options
     Do not move layer workspace to attic if inline SCM switching is not possible.
     Instead a build error is issued.
 
+``--format {yaml,json,flat}``
+   Selects a different output format. Defaults to ``yaml``. The ``flat`` format
+   is an INI-style format where each key/value pair is printed on a separate
+   line.
+
+``--indent INDENT``
+   The ``yaml`` and ``json`` output formats are pretty printed with an
+   indentation of 4 spaces by default. Use this option to chance this to
+   ``INDENT`` number of spaces.
+
+``--no-indent``
+   Disables the pretty printing of the ``yaml`` and ``json`` formats. The
+   output will be more compact but is less readable.
+
 ``-lc LAYERCONFIG``
     Use additional layer configuration file.
 

doc/manual/configuration.rst

@@ -2141,7 +2141,8 @@ possibility is to provide an SCM-Dictionary (see
 
 If a layer SCM specification is given, Bob takes care of the layer management:
 
-- Layers are checked out / updated during bob-build (except build-only).
+- Layers are checked out / updated automatically during
+  :ref:`manpage-dev`/:ref:`manpage-build` (except ``--build-only`` builds).
 - The ``bob layers`` command can update layers or show their status (see
   :ref:`manpage-layers`).
 
@@ -2152,9 +2153,10 @@ If a layer SCM specification is given, Bob takes care of the layer management:
 
 Only git, svn, url and cvs SCMs are supported for layers. Because layers are
 fetched and updated before any :ref:`configuration-config-usr` is parsed, the
-regular ``whitelist`` and ``scmOverrides`` settings are not used.  Instead,
+regular ``whitelist`` and ``scmOverrides`` settings are not used. Instead,
 layer checkouts are controlled by ``layersWhitelist`` and
-``layersScmOverrides``.
+``layersScmOverrides``. These settings can be optionally overridden from the
+command line by passing a layers configuration file with the ``-lc`` option.
 
 layersWhitelist
 ~~~~~~~~~~~~~~~

pym/bob/cmds/build/build.py

@@ -12,7 +12,8 @@
 from ...layers import updateLayers
 from ...share import getShare
 from ...tty import setVerbosity, setTui, Warn
-from ...utils import copyTree, processDefines, EventLoopWrapper, SandboxMode
+from ...utils import copyTree, EventLoopWrapper, SandboxMode
+from ..helpers import processDefines
 import argparse
 import datetime
 import re

pym/bob/cmds/build/clean.py

@@ -9,7 +9,8 @@
 from ...share import getShare
 from ...state import BobState
 from ...tty import colorize, ERROR, WARNING, EXECUTED, DEFAULT, Warn
-from ...utils import removePath, processDefines
+from ...utils import removePath
+from ..helpers import processDefines
 import argparse
 import os
 

pym/bob/cmds/build/project.py

@@ -8,7 +8,8 @@
 from ...generators import generators as defaultGenerators
 from ...input import RecipeSet
 from ...tty import colorize
-from ...utils import processDefines, SandboxMode
+from ...utils import SandboxMode
+from ..helpers import processDefines
 import argparse
 import os
 

pym/bob/cmds/build/query.py

@@ -6,7 +6,7 @@
 from ...builder import LocalBuilder
 from ...errors import ParseError
 from ...input import RecipeSet
-from ...utils import processDefines
+from ..helpers import processDefines
 from string import Formatter
 import argparse
 import os

pym/bob/cmds/build/status.py

@@ -9,7 +9,8 @@
 from ...state import BobState
 from ...tty import colorize, ERROR, WARNING, EXECUTED, DEFAULT, SKIPPED, \
     IMPORTANT, NORMAL, INFO, DEBUG, TRACE, HEADLINE
-from ...utils import joinLines, processDefines
+from ...utils import joinLines
+from ..helpers import processDefines
 from textwrap import indent
 import argparse
 import os

pym/bob/cmds/graph.py

@@ -6,7 +6,8 @@
 from .. import BOB_VERSION
 from ..input import RecipeSet
 from ..tty import colorize
-from ..utils import processDefines, runInEventLoop
+from ..utils import runInEventLoop
+from .helpers import processDefines
 import argparse
 import asyncio
 import json

pym/bob/cmds/helpers.py

@@ -0,0 +1,39 @@
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+def processDefines(defs):
+    """Convert a list of 'KEY=VALUE' strings into a dict"""
+    defines = {}
+    for define in defs:
+        key, _sep, value = define.partition('=')
+        defines[key] = value
+    return defines
+
+
+def dumpYaml(doc, indent):
+    if indent is None:
+        style = None
+    else:
+        style = False
+
+    import yaml
+    return yaml.dump(doc, default_flow_style=style, indent=indent)
+
+def dumpJson(doc, indent):
+    import json
+    return json.dumps(doc, indent=indent, sort_keys=True)
+
+def dumpFlat(doc, prefix=""):
+    ret = []
+    if isinstance(doc, dict):
+        for k,v in sorted(doc.items()):
+            ret.extend(dumpFlat(v, prefix+"."+k if prefix else k))
+    elif isinstance(doc, list):
+        i = 0
+        for v in doc:
+            ret.extend(dumpFlat(v, "{}[{}]".format(prefix, i)))
+            i += 1
+    else:
+        doc = str(doc).replace('\n', '\\n')
+        ret = [ "{}={}".format(prefix, doc) ]
+
+    return ret