diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-25 17:52:19 +0900 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-08-25 18:10:53 +0900 |
| commit | 4f8fe9778023748e4354c103c37475f7bcabe51e (patch) | |
| tree | 16a5f6ad41d6b4ef0f1cb03a894c0875a235e158 | |
| parent | 24cb303756b7e2953f0e250348c2b814dc3acea0 (diff) | |
| download | buildstream-tristan/fixup-workspace-docs.tar.gz | |
HACKING.rst: Documenting the new "shell" configuration in the bst2html input file formattristan/fixup-workspace-docs
| -rw-r--r-- | HACKING.rst | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/HACKING.rst b/HACKING.rst index 74256c7b3..1c5832597 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -390,6 +390,9 @@ Each *command* is a dictionary, the members of which are listed here: * ``command``: The command to run, without the leading ``bst`` +* ``shell``: Specifying ``True`` indicates that ``command`` should be run as + a shell command from the project directory, instead of a bst command (optional) + When adding a new ``.run`` file, one should normally also commit the new resulting generated ``.html`` file(s) into the ``doc/source/sessions-stored/`` directory at the same time, this ensures that other developers do not need to |