Skip to content

Commit 3490f16

Browse files
committed
tox.ini: Fix tox -e man manpage regeneration
The new man pages now include the bst version in them, and the documentation about generating man pages is also updated to specify that one should specify `tox -e man -- <version>`.
1 parent dc81305 commit 3490f16

File tree

2 files changed

+12
-5
lines changed

2 files changed

+12
-5
lines changed

doc/source/hacking/writing_documentation.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -112,9 +112,11 @@ into the ``setup.py``, as such, whenever the frontend command line
112112
interface changes, the static man pages should be regenerated and
113113
committed with that.
114114

115-
To do this, run the following from the the toplevel directory of BuildStream::
115+
To do this, make sure you know the version you are generating the docs
116+
for, which should usually be the *next* ``major.minor`` version of BuildStream,
117+
and then run the following from the the toplevel directory of BuildStream::
116118

117-
tox -e man
119+
tox -e man -- <version>
118120

119121
And commit the result, ensuring that you have added anything in
120122
the ``man/`` subdirectory, which will be automatically included

tox.ini

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -208,16 +208,21 @@ passenv =
208208
allowlist_externals =
209209
make
210210

211+
211212
#
212213
# (re-)Generating man pages
213214
#
214215
[testenv:man]
215216
commands =
216-
python3 setup.py --command-packages=click_man.commands man_pages
217+
# We set the version to 0, because click-man would now
218+
# otherwise want to pull a hardcoded version from pyproject.toml
219+
# that somehow gets magically transported to the EntryPoint.version
220+
click-man --man-version {posargs} --target man bst
217221
deps =
218-
click-man >= 0.3.0
219-
Cython
222+
click-man >= 0.5.0
220223
-rrequirements/requirements.txt
224+
-rrequirements/dev-requirements.txt
225+
Cython
221226

222227

223228
#

0 commit comments

Comments
 (0)