diff options
| -rw-r--r-- | CONTRIBUTING.rst | 9 | ||||
| -rwxr-xr-x | setup.py | 5 |
2 files changed, 4 insertions, 10 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index c8c1f29e5..815acfca6 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -1259,14 +1259,9 @@ into the ``setup.py``, as such, whenever the frontend command line interface changes, the static man pages should be regenerated and committed with that. -To do this, first ensure you have ``click_man`` installed, possibly -with:: +To do this, run the following from the the toplevel directory of BuildStream:: - pip3 install --user click_man - -Then, in the toplevel directory of buildstream, run the following:: - - python3 setup.py --command-packages=click_man.commands man_pages + tox -e man And commit the result, ensuring that you have added anything in the ``man/`` subdirectory, which will be automatically included @@ -100,10 +100,9 @@ def check_for_bwrap(): # Man pages are automatically generated however it was too difficult # to integrate with setuptools as a step of the build (FIXME !). # -# To update the man pages in tree before a release, you need to -# ensure you have the 'click_man' package installed, and run: +# To update the man pages in tree before a release, run: # -# python3 setup.py --command-packages=click_man.commands man_pages +# tox -e man # # Then commit the result. # |