Skip to content

Commit

Permalink
doc: update dev/build manpages
Browse files Browse the repository at this point in the history
Document the new "-lc" option.
  • Loading branch information
jkloetzke committed Oct 10, 2024
1 parent ce2e547 commit 1aae83d
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 11 deletions.
11 changes: 11 additions & 0 deletions doc/manpages/bob-build-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,17 @@ Options
it cannot be built either, the other dependencies are still processed.
Normally Bob stops on the first error that is encountered.

``-lc LAYERCONFIG``
Use additional layer configuration file.

This is special kind of configuration file to control the layers checkout. Only
``layersWhitelist`` and ``layersScmOverrides`` are supported. Layers are
updated automatically unless ``--build-only`` is given too.

The ``.yaml`` suffix is appended automatically and the configuration file
is searched relative to the project root directory unless an absolute path
is given.

``--no-attic``
Do not move checkout workspace to attic if inline SCM switching is not possible.
Instead a build error is issued.
Expand Down
11 changes: 5 additions & 6 deletions doc/manpages/bob-build.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@ Synopsis
[--without-provided] [-A | --audit] [-b | -B | --normal]
[--clean | --incremental] [--always-checkout RE] [--resume]
[-q] [-v] [--no-logfiles] [-D DEFINES] [-c CONFIGFILE]
[-e NAME] [-E] [-M META] [--upload] [--link-deps]
[--no-link-deps] [--download MODE] [--download-layer MODE]
[--shared | --no-shared] [--install | --no-install]
[--sandbox | --no-sandbox] [--clean-checkout]
[--attic | --no-attic]
[-lc LAYERCONFIG] [-e NAME] [-E] [-M META] [--upload]
[--link-deps] [--no-link-deps] [--download MODE]
[--download-layer MODE] [--shared | --no-shared]
[--install | --no-install] [--sandbox | --no-sandbox]
[--clean-checkout] [--attic | --no-attic]
PACKAGE [PACKAGE ...]


Description
-----------

Expand Down
10 changes: 5 additions & 5 deletions doc/manpages/bob-dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ Synopsis
[--without-provided] [-A | --audit] [-b | -B | --normal]
[--clean | --incremental] [--always-checkout RE] [--resume]
[-q] [-v] [--no-logfiles] [-D DEFINES] [-c CONFIGFILE]
[-e NAME] [-E] [-M META] [--upload] [--link-deps]
[--no-link-deps] [--download MODE] [--download-layer MODE]
[--shared | --no-shared] [--install | --no-install]
[--sandbox | --no-sandbox] [--clean-checkout]
[--attic | --no-attic]
[-lc LAYERCONFIG] [-e NAME] [-E] [-M META] [--upload]
[--link-deps] [--no-link-deps] [--download MODE]
[--download-layer MODE] [--shared | --no-shared]
[--install | --no-install] [--sandbox | --no-sandbox]
[--clean-checkout] [--attic | --no-attic]
PACKAGE [PACKAGE ...]


Expand Down

0 comments on commit 1aae83d

Please sign in to comment.