diff mbox series

[1/2] bitbake-layers/create: Improve help message for layerid argument

Message ID 20250924-minor-fixes-v1-1-affc85657a66@pbarker.dev
State New
Headers show
Series Minor fixes for bitbake-layers & patchtest | expand

Commit Message

Paul Barker Sept. 24, 2025, 7:57 p.m. UTC 
'Layer ID' isn't a commonly used term in our help messages or
documentation, so clarify that this is the identifier used for the new
layer in BBFILE_COLLECTIONS.

Also clarify that the default is the basename of the layerdir argument
if a layer ID is not separately provided.

Signed-off-by: Paul Barker <paul@pbarker.dev>
---
 meta/lib/bblayers/create.py | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/meta/lib/bblayers/create.py b/meta/lib/bblayers/create.py
index 517554c587d76989169c67ec1a2e8bd0713f8b1e..b38c4b5e38a475fe07b40968f168857d565d9722 100644
--- a/meta/lib/bblayers/create.py
+++ b/meta/lib/bblayers/create.py
@@ -83,7 +83,7 @@  class CreatePlugin(LayerPlugin):
         parser_create_layer = self.add_command(sp, 'create-layer', self.do_create_layer, parserecipes=False)
         parser_create_layer.add_argument('layerdir', help='Layer directory to create')
         parser_create_layer.add_argument('--add-layer', '-a', action='store_true', help='Add the layer to bblayers.conf after creation')
-        parser_create_layer.add_argument('--layerid', '-i', help='Layer id to use if different from layername')
+        parser_create_layer.add_argument('--layerid', '-i', help='Layer ID to use in BBFILE_COLLECTIONS, if different from the layerdir basename')
         parser_create_layer.add_argument('--priority', '-p', default=6, help='Priority of recipes in layer')
         parser_create_layer.add_argument('--example-recipe-name', '-e', dest='examplerecipe', default='example', help='Filename of the example recipe')
         parser_create_layer.add_argument('--example-recipe-version', '-v', dest='version', default='0.1', help='Version number for the example recipe')