summaryrefslogtreecommitdiff
path: root/HACKING.rst
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-15 14:43:33 -0400
committerTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2018-06-16 13:27:49 -0400
commita01a5cc8ea55495eb07bc12557c00e633f307149 (patch)
treee2d89652663d2246dd836434a5d3c50819eabf6e /HACKING.rst
parent5ba5415ed3474759331c1d065cfe7051e0a64fd5 (diff)
downloadbuildstream-a01a5cc8ea55495eb07bc12557c00e633f307149.tar.gz
doc/bst2html.py: Add support for `fake-output` when running commands.
When specifying a fake-output string, we don't really run the command or assume it was a `bst` command, and we pretend that `fake-output` was the output of the command. Specifying an empty string explicitly enables the behavior too for faking a command that has no stdout/stderr. This also adds the "remove-files" hack allowing the session scripts to remove files before executing commands (kind of unsure if we're gonna keep this...)
Diffstat (limited to 'HACKING.rst')
-rw-r--r--HACKING.rst3
1 files changed, 3 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst
index d326a7b35..1c9624090 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -383,6 +383,9 @@ Each *command* is a dictionary, the members of which are listed here:
* ``output``: The input file relative output html file to generate (optional)
+* ``fake-output``: Don't really run the command, just pretend to and pretend
+ this was the output, an empty string will enable this too.
+
* ``command``: The command to run, without the leading ``bst``
When adding a new ``.run`` file, one should normally also commit the new