Some fixes in _GenerateKVMBlockDevicesOptions()
[ganeti-local] / doc / devnotes.rst
index bf8cddf..d6cfc2c 100644 (file)
@@ -21,6 +21,7 @@ Most dependencies from :doc:`install-quick`, including ``qemu-img``
 - `pylint <http://www.logilab.org/857>`_ and its associated
   dependencies
 - `pep8 <https://github.com/jcrocholl/pep8/>`_
+- `PyYAML <http://pyyaml.org/>`_
 
 For older developement (Ganeti < 2.4) ``docbook`` was used instead
 ``pandoc``.
@@ -29,26 +30,29 @@ Note that for pylint, at the current moment the following versions
 must be used::
 
     $ pylint --version
-    pylint 0.21.1,
-    astng 0.20.1, common 0.50.3
+    pylint 0.25.1,
+    astng 0.23.1, common 0.58.0
 
 The same with pep8, other versions may give you errors::
 
      $ pep8 --version
      1.2
 
+Both these versions are the ones shipped with Debian Wheezy.
+
 To generate unittest coverage reports (``make coverage``), `coverage
 <http://pypi.python.org/pypi/coverage>`_ needs to be installed.
 
 Installation of all dependencies listed here::
 
-     $ apt-get install python-setuptools
+     $ apt-get install python-setuptools automake git fakeroot
      $ apt-get install pandoc python-epydoc graphviz
+     $ apt-get install python-yaml
      $ cd / && sudo easy_install \
                sphinx \
-               logilab-astng==0.20.1 \
-               logilab-common==0.50.3 \
-               pylint==0.21.1 \
+               logilab-astng==0.23.1 \
+               logilab-common==0.58.0 \
+               pylint==0.25.1 \
                pep8==1.2 \
                coverage
 
@@ -69,7 +73,7 @@ document, plus:
 - the `test-framework
   <http://batterseapower.github.com/test-framework/>`_ libraries,
   tested versions: ``test-framework``: 0.6, ``test-framework-hunit``:
-  0.2.7, ``test-framework-quickcheck2``: 0.2.12
+  0.2.7, ``test-framework-quickcheck2``: 0.2.12.1
 - ``hpc``, which comes with the compiler, so you should already have
   it
 - `shelltestrunner <http://joyful.com/shelltestrunner>`_, used for
@@ -134,7 +138,7 @@ Or, more interactively::
 
   $ ghci
   λ> :set -ddump-splices
-  λ> :l htools/Ganeti/Objects.hs
+  λ> :l src/Ganeti/Objects.hs
 
 And you will get the spliced code as the module is loaded.
 
@@ -150,9 +154,9 @@ build profiling code. The recommended way is to run ``make hs-prof``,
 or alternatively the manual sequence is::
 
   $ make clean
-  $ make htools/htools HEXTRA="-osuf .o"
-  $ rm htools/htools
-  $ make htools/htools HEXTRA="-osuf .prof_o -prof -auto-all"
+  $ make src/htools HEXTRA="-osuf .o"
+  $ rm src/htools
+  $ make src/htools HEXTRA="-osuf .prof_o -prof -auto-all"
 
 This will build the binary twice, per the TemplateHaskell
 documentation, the second one with profiling enabled.
@@ -176,11 +180,11 @@ so for shell-tests (but these are faster, so it shouldn't be needed).
 For Python tests::
 
   $ export PYTHONPATH=$PWD
-  $ python ./test/ganeti.%mytest%
+  $ python ./test/py/ganeti.%mytest%
 
 For Haskell tests::
 
-  $ make htest/test && ./htest/test -t %pattern%
+  $ make test/hs/htest && ./test/hs/htest -t %pattern%
 
 Where ``pattern`` can be a simple test pattern (e.g. ``comma``,
 matching any test whose name contains ``comma``), a test pattern