- change version number

- add notes for pyparallel on linux, thanks K. Ari Krupnikov

2 files changed, 27 insertions, 2 deletions

diff --git a/documentation/conf.py b/documentation/conf.py
index 8f5943a..7420982 100644
--- a/documentation/conf.py
+++ b/documentation/conf.py
@@ -45,9 +45,9 @@ copyright = u'2009, Chris Liechti'
 # built documents.
 #
 # The short X.Y version.
-version = '2.4'
+version = '2.5'
 # The full version, including alpha/beta/rc tags.
-release = '2.4'
+release = '2.5 preview'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
diff --git a/documentation/pyparallel.rst b/documentation/pyparallel.rst
index b7bab7d..00c0b95 100644
--- a/documentation/pyparallel.rst
+++ b/documentation/pyparallel.rst
@@ -129,6 +129,31 @@ API
     for tests and simulations without real hardware.
 
 
+Notes
+=====
+
+Linux
+-----
+1. The :manpage:`lp(4)` module must be unloaded, ``rmmod lp``. ``lp`` claims
+   exclusive access to the port and other programs won't be able to use it.
+
+2. The :manpage:`ppdev(4)` module needs to be loaded, ``modprobe ppdev``. When
+   ``udev`` is in use, (default with 2.6 kernels) this will create a
+   ``/dev/parport0``.
+
+3. The user needs to have write permissions to ``/dev/parport0``. Many
+   distributions have an ``lp`` group that owns the device; the simplest is to
+   add the user account to this group. Simply changing permissions on the
+   device is not the best strategy as they will be reverted to their defaults
+   next time the driver is loaded.
+
+
+Windows
+-------
+The giveio driver must be installed as the module needs direct access to the
+hardware. This also means that USB parallel port adapters won't be supported.
+
+
 Misc
 ====
 References