diff options
| author | Giampaolo Rodola <g.rodola@gmail.com> | 2016-05-15 12:55:03 -0400 |
|---|---|---|
| committer | Giampaolo Rodola <g.rodola@gmail.com> | 2016-05-15 12:55:03 -0400 |
| commit | e8d558145d5db1526b239ae378aad2df47b7a343 (patch) | |
| tree | 8cdea1140b2f88e08c6be5115fcba26c1f46065b /DEVGUIDE.rst | |
| parent | bda8c65d7557904f895a5d795ced1c33508d6cc8 (diff) | |
| download | psutil-e8d558145d5db1526b239ae378aad2df47b7a343.tar.gz | |
update doc
Diffstat (limited to 'DEVGUIDE.rst')
| -rw-r--r-- | DEVGUIDE.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/DEVGUIDE.rst b/DEVGUIDE.rst index 691d5db4..fd9b62cd 100644 --- a/DEVGUIDE.rst +++ b/DEVGUIDE.rst @@ -67,8 +67,10 @@ Typical process occurring when adding a new functionality (API): ``psutil/_psutil_{platform}.c`` (e.g. ``psutil/_psutil_linux.c``). - write a generic test in ``psutil/tests/test_system.py`` or ``psutil/tests/test_process.py``. -- if possible, write a cross platform test in +- if possible, write a platform specific test in ``psutil/tests/test_{platform}.py`` (e.g. ``test_linux.py``). + This usually means testing the return value of the new feature against + a system CLI tool. - update doc in ``doc/index.py``. - update ``HISTORY.rst``. - update ``README.rst`` (if necessary). @@ -127,7 +129,7 @@ Documentation - it uses `RsT syntax <http://docutils.sourceforge.net/docs/user/rst/quickref.html>`_ and it's built with `sphinx <http://sphinx-doc.org/>`_. - doc can be built with ``make setup-dev-env; cd docs; make html``. -- public is hosted on http://pythonhosted.org/psutil/. +- public doc is hosted on http://pythonhosted.org/psutil/. - it is uploaded on every new release with ``make upload-doc``. ======================= @@ -139,6 +141,8 @@ These are note for myself (Giampaolo): - make sure all tests pass and all builds are green. - upload source tarball on PYPI with ``make upload-src``. - upload exe and wheel files for windows on PYPI with ``make upload-all``. + - ...or by using atrifacts hosted on AppVeyor with ``make win-download-exes`` + and ``make win-upload-exes``, - upload updated doc on http://pythonhosted.org/psutil with ``make upload-doc``. - GIT tag the new release with ``make git-tag-release``. - post on psutil and python-announce mailing lists, twitter, g+, blog. @@ -150,7 +154,8 @@ FreeBSD notes - setup: .. code-block:: bash + $ pkg install python python3 gcc git vim screen bash $ chsh -s /usr/local/bin/bash user # set bash as default shell -- `/usr/src` contains the source codes for all installed CLI tools (grep in it).
\ No newline at end of file +- `/usr/src` contains the source codes for all installed CLI tools (grep in it). |