summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChandan Singh <chandan@chandansingh.net>2020-03-04 16:50:59 +0000
committerChandan Singh <chandan@chandansingh.net>2020-03-04 16:50:59 +0000
commit71179f88b93ff06543ae2b3b40c09801bca46552 (patch)
treeb86a2e6a14a1fbbf70520f47c492fda980dd403c
parentc4001c803d38564d037bade56cc8fb5a1bd4ebe0 (diff)
parent8edf4822b262f7a886382a42c6dff1a7c84ff7bf (diff)
downloadbuildstream-71179f88b93ff06543ae2b3b40c09801bca46552.tar.gz
Merge branch 'chandan/fix-bst-show-formatting' into 'master'
_frontend/cli.py: Fix formatting for `bst show` help text Closes #323 See merge request BuildStream/buildstream!1824
-rw-r--r--src/buildstream/_frontend/cli.py11
1 files changed, 5 insertions, 6 deletions
diff --git a/src/buildstream/_frontend/cli.py b/src/buildstream/_frontend/cli.py
index 52848ca2e..44bb99f92 100644
--- a/src/buildstream/_frontend/cli.py
+++ b/src/buildstream/_frontend/cli.py
@@ -546,7 +546,7 @@ def show(app, elements, deps, except_, order, format_):
By default this will show all of the dependencies of the
specified target element.
- Specify `--deps` to control which elements to show:
+ Specify ``--deps`` to control which elements to show:
\b
none: No dependencies, just the element itself
@@ -555,10 +555,9 @@ def show(app, elements, deps, except_, order, format_):
build: Build time dependencies, excluding the element itself
all: All dependencies
- \b
- FORMAT
- ~~~~~~
- The --format option controls what should be printed for each element,
+ **FORMAT**
+
+ The ``--format`` option controls what should be printed for each element,
the following symbols can be used in the format string:
\b
@@ -578,7 +577,7 @@ def show(app, elements, deps, except_, order, format_):
The value of the %{symbol} without the leading '%' character is understood
as a pythonic formatting string, so python formatting features apply,
- examle:
+ example:
\b
bst show target.bst --format \\