Commit 6fa3f922 authored by Tristan Van Berkom's avatar Tristan Van Berkom

doc/Makefile: Stage stored sessions from session-stored

Separate the revisioned provisional session html files such
that the git tree does not become dirty as a result of a
documentation build process - which messes up the docs version
number and the version number printed in some command line output.
parent 1b88e2c6
Pipeline #23994374 passed with stages
in 31 minutes and 8 seconds
......@@ -389,9 +389,9 @@ Each *command* is a dictionary, the members of which are listed here:
* ``command``: The command to run, without the leading ``bst``
When adding a new ``.run`` file, one should normally also commit the new
resulting generated ``.html`` file(s) at the same time, this ensures that
other developers do not need to regenerate them locally in order to build
the docs.
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
regenerate them locally in order to build the docs.
**Example**:
......
......@@ -32,7 +32,7 @@ BST2HTMLOPTS = --force
endif
.PHONY: all clean templates templates-clean sessions sessions-clean html devhelp
.PHONY: all clean templates templates-clean sessions sessions-prep sessions-clean html devhelp
# Canned recipe for generating plugin api skeletons
# $1 = the plugin directory
......@@ -84,11 +84,24 @@ templates-clean:
rm -rf source/elements
rm -rf source/sources
# Generate the html fragments of colorized BuildStream terminal output only
# if they don't yet exist. This is expensive so you need to run `make clean` first
# if you want to regenerate them.
# Stage the stored sessions into the place where they will
# be used in the build.
#
sessions:
# This is separated so that the git tree does not become
# dirty as a result of a documentation build process - which
# messes up the docs version number and the version number
# printed in some command line output.
#
sessions-prep:
mkdir -p source/sessions
cp source/sessions-stored/*.html source/sessions
# By default, this will generate the html fragments of colorized BuildStream terminal
# output only if they don't yet exist.
#
# Specify BST_FORCE_SESSION_REBUILD=1 to force rebuild all session html files.
#
sessions: sessions-prep
for file in $(wildcard sessions/*.run); do \
$(BST2HTML) $(BST2HTMLOPTS) --description $$file; \
done
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment