diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-15 15:15:30 -0400 |
|---|---|---|
| committer | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2018-06-16 15:44:56 -0400 |
| commit | b592a80b0e4e244ce50b2452ffcd655fd843bf81 (patch) | |
| tree | 012dd6c04df96d61a031711439d8a1822660c286 /HACKING.rst | |
| parent | a01a5cc8ea55495eb07bc12557c00e633f307149 (diff) | |
| download | buildstream-b592a80b0e4e244ce50b2452ffcd655fd843bf81.tar.gz | |
doc/bst2html.py, doc/Makefile: Added --force option
If --force is not specified, then we'll skip session files in
the case that all of the outputs exist.
Now setting BST_FORCE_SESSION_REBUILD when building the docs
will cause the session files to be rebuilt regardless of whether
they exist or not.
The .gitlab-ci.yml was also changed to use this and force rebuilds.
Diffstat (limited to 'HACKING.rst')
| -rw-r--r-- | HACKING.rst | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/HACKING.rst b/HACKING.rst index 1c9624090..46245ab78 100644 --- a/HACKING.rst +++ b/HACKING.rst @@ -269,9 +269,9 @@ you can view in your browser locally to test. Regenerating session html ''''''''''''''''''''''''' -The documentation build will only build the session files if explicitly -asked to. We revision the generated session html files in order to reduce -the burden on documentation contributors. +The documentation build will build the session files if they are missing, +or if explicitly asked to rebuild. We revision the generated session html files +in order to reduce the burden on documentation contributors. To explicitly rebuild the session snapshot html files, it is recommended that you first set the ``BST_SOURCE_CACHE`` environment variable to your source cache, this @@ -279,9 +279,9 @@ will make the docs build reuse already downloaded sources:: export BST_SOURCE_CACHE=~/.cache/buildstream/sources -To force build the session html, simply run the following:: +To force rebuild session html while building the doc, simply build the docs like this:: - make -C doc sessions + make BST_FORCE_SESSION_REBUILD=1 -C doc Man pages |