From 474e4afe97d6510a94c7bd0ed9ae4b6dda4efb60 Mon Sep 17 00:00:00 2001
From: Olivier Tilloy <olivier@tilloy.net>
Date: Thu, 18 Mar 2010 17:45:13 +0100
Subject: Document the --user switch and the DESTDIR variable in the
 developers' documentation.

---
 doc/developers.rst | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

(limited to 'doc')

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
 #############
-- 
cgit