aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorOlivier Tilloy <olivier@tilloy.net>2010-03-18 17:45:13 +0100
committerOlivier Tilloy <olivier@tilloy.net>2010-03-18 17:45:13 +0100
commit474e4afe97d6510a94c7bd0ed9ae4b6dda4efb60 (patch)
tree628ead040138db4a6ffbcc9197650758844295d1 /doc
parent98794df599a7ede7209bc5431d1c98d5ae2bcb07 (diff)
downloadpyexiv2-474e4afe97d6510a94c7bd0ed9ae4b6dda4efb60.tar.gz
Document the --user switch and the DESTDIR variable in the developers' documentation.
Diffstat (limited to 'doc')
-rw-r--r--doc/developers.rst12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc/developers.rst b/doc/developers.rst
index 8bf39bd..b6fe88b 100644
--- a/doc/developers.rst
+++ b/doc/developers.rst
@@ -68,8 +68,16 @@ the build directory::
osomon@granuja:~/dev/pyexiv2$ ls build/
exiv2wrapper.os exiv2wrapper_python.os libexiv2python.so
-To install pyexiv2, just invoke ``scons install``. You will most likely need
-administrative privileges to proceed.
+To install pyexiv2 system-wide, just invoke ``scons install``.
+You will most likely need administrative privileges to proceed.
+The ``--user`` switch will install pyexiv2 in the current
+`user site directory <http://www.python.org/dev/peps/pep-0370/>`_
+(Python ≥ 2.6 is required).
+
+Note to packagers:
+if `DESTDIR <http://www.gnu.org/prep/standards/html_node/DESTDIR.html>`_ is
+specified on the command line when invoking ``scons install``, its value will be
+prepended to each installed target file.
Documentation
#############