summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-06-28 14:54:17 +0900
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2017-06-28 14:54:17 +0900
commitb99d697e740d1236cda7596d981023010ae9d9f4 (patch)
tree2d419514fc634387a5759df71758ef74e56a7cc5
parent99dc99fcc8f6272802d7da685c4b4a26ee3a4504 (diff)
downloadbuildstream-b99d697e740d1236cda7596d981023010ae9d9f4.tar.gz
main.py: Enhanced some documentation on the new source-bundle command
Was missing a help string for the deps argument and a blurb explaining the meaning of those (consistency with other commands). Also removed the 'plan' option as that makes no sense for source-bundle.
-rw-r--r--buildstream/_frontend/main.py10
1 files changed, 9 insertions, 1 deletions
diff --git a/buildstream/_frontend/main.py b/buildstream/_frontend/main.py
index e41f21bac..1b7bf7125 100644
--- a/buildstream/_frontend/main.py
+++ b/buildstream/_frontend/main.py
@@ -373,7 +373,8 @@ def checkout(app, target, arch, variant, directory, force):
type=click.Choice(['none', 'gz', 'bz2', 'xz']),
help="Compress the tar file using the given algorithm.")
@click.option('--deps', '-d', default='build',
- type=click.Choice(['none', 'plan', 'run', 'build']))
+ type=click.Choice(['none', 'run', 'build']),
+ help='The elements to bundle (default: build)')
@click.option('--track', default=False, is_flag=True,
help="Track new source references before building")
@click.option('--arch', '-a', default=host_machine,
@@ -388,6 +389,13 @@ def checkout(app, target, arch, variant, directory, force):
def source_bundle(app, name, target, arch, variant, force,
track, deps, compression, except_):
"""Produce a build bundle to be manually executed
+
+ Specify `--deps` to control which elements to show:
+
+ \b
+ none: No dependencies, just the element itself
+ run: Runtime dependencies, including the element itself
+ build: Build time dependencies, excluding the element itself
"""
app.initialize(target, arch, variant, rewritable=track, inconsistent=track)
try: