summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--HACKING.rst6
-rw-r--r--doc/Makefile23
-rw-r--r--doc/source/sessions-stored/first-project-build.html (renamed from doc/source/sessions/first-project-build.html)0
-rw-r--r--doc/source/sessions-stored/first-project-checkout.html (renamed from doc/source/sessions/first-project-checkout.html)0
-rw-r--r--doc/source/sessions-stored/first-project-init.html (renamed from doc/source/sessions/first-project-init.html)0
-rw-r--r--doc/source/sessions-stored/first-project-ls.html (renamed from doc/source/sessions/first-project-ls.html)0
-rw-r--r--doc/source/sessions-stored/first-project-show.html (renamed from doc/source/sessions/first-project-show.html)0
-rw-r--r--doc/source/sessions-stored/first-project-touch.html (renamed from doc/source/sessions/first-project-touch.html)0
-rw-r--r--doc/source/sessions-stored/flatpak-autotools-build.html (renamed from doc/source/sessions/flatpak-autotools-build.html)0
-rw-r--r--doc/source/sessions-stored/flatpak-autotools-shell.html (renamed from doc/source/sessions/flatpak-autotools-shell.html)0
10 files changed, 21 insertions, 8 deletions
diff --git a/HACKING.rst b/HACKING.rst
index 46245ab78..dd791bd24 100644
--- a/HACKING.rst
+++ b/HACKING.rst
@@ -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**:
diff --git a/doc/Makefile b/doc/Makefile
index 70df67184..eaef15a61 100644
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -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
diff --git a/doc/source/sessions/first-project-build.html b/doc/source/sessions-stored/first-project-build.html
index e3766a73b..e3766a73b 100644
--- a/doc/source/sessions/first-project-build.html
+++ b/doc/source/sessions-stored/first-project-build.html
diff --git a/doc/source/sessions/first-project-checkout.html b/doc/source/sessions-stored/first-project-checkout.html
index 2b994e0c2..2b994e0c2 100644
--- a/doc/source/sessions/first-project-checkout.html
+++ b/doc/source/sessions-stored/first-project-checkout.html
diff --git a/doc/source/sessions/first-project-init.html b/doc/source/sessions-stored/first-project-init.html
index ba29791fa..ba29791fa 100644
--- a/doc/source/sessions/first-project-init.html
+++ b/doc/source/sessions-stored/first-project-init.html
diff --git a/doc/source/sessions/first-project-ls.html b/doc/source/sessions-stored/first-project-ls.html
index 97e7f16dc..97e7f16dc 100644
--- a/doc/source/sessions/first-project-ls.html
+++ b/doc/source/sessions-stored/first-project-ls.html
diff --git a/doc/source/sessions/first-project-show.html b/doc/source/sessions-stored/first-project-show.html
index aa3c8b8f7..aa3c8b8f7 100644
--- a/doc/source/sessions/first-project-show.html
+++ b/doc/source/sessions-stored/first-project-show.html
diff --git a/doc/source/sessions/first-project-touch.html b/doc/source/sessions-stored/first-project-touch.html
index a7e0338d6..a7e0338d6 100644
--- a/doc/source/sessions/first-project-touch.html
+++ b/doc/source/sessions-stored/first-project-touch.html
diff --git a/doc/source/sessions/flatpak-autotools-build.html b/doc/source/sessions-stored/flatpak-autotools-build.html
index 147e728b5..147e728b5 100644
--- a/doc/source/sessions/flatpak-autotools-build.html
+++ b/doc/source/sessions-stored/flatpak-autotools-build.html
diff --git a/doc/source/sessions/flatpak-autotools-shell.html b/doc/source/sessions-stored/flatpak-autotools-shell.html
index b9943ca2d..b9943ca2d 100644
--- a/doc/source/sessions/flatpak-autotools-shell.html
+++ b/doc/source/sessions-stored/flatpak-autotools-shell.html