diff options
author | Chandan Singh <csingh43@bloomberg.net> | 2019-01-24 21:20:21 +0000 |
---|---|---|
committer | Chandan Singh <chandan@chandansingh.net> | 2019-01-25 23:50:49 +0000 |
commit | 4edbbd27c295e3f5498d3e721941cb8a91da4fd3 (patch) | |
tree | 8237a9731d6072db54ae88c787f2a85133773d57 | |
parent | d74386886a1ca53a394dc80c1a29c777e087398a (diff) | |
download | buildstream-4edbbd27c295e3f5498d3e721941cb8a91da4fd3.tar.gz |
setup.py, CONTRIBUTING.rst: Recommend using tox to generate man pages
Simplify our docs, by requesting users to run `tox -e man` to update man
pages, instead of manually installing `click-man` and running the
command manually.
-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. # |