Revision fc6075dd doc/devnotes.rst

b/doc/devnotes.rst
6 6
Build dependencies
7 7
------------------
8 8

  
9
Most dependencies from :doc:`install-quick`, plus (for Python):
9
Most dependencies from :doc:`install-quick`, including ``qemu-img``
10
(marked there as optional) plus (for Python):
10 11

  
11 12
- `GNU make <http://www.gnu.org/software/make/>`_
12 13
- `GNU tar <http://www.gnu.org/software/tar/>`_
13 14
- `Gzip <http://www.gnu.org/software/gzip/>`_
14 15
- `pandoc <http://johnmacfarlane.net/pandoc/>`_
16
- `python-epydoc <http://epydoc.sourceforge.net/>`_
15 17
- `python-sphinx <http://sphinx.pocoo.org/>`_
16
  (tested with version 0.6.1)
18
  (tested with version 1.1.3)
17 19
- `graphviz <http://www.graphviz.org/>`_
18 20
- the `en_US.UTF-8` locale must be enabled on the system
19 21
- `pylint <http://www.logilab.org/857>`_ and its associated
20 22
  dependencies
21 23
- `pep8 <https://github.com/jcrocholl/pep8/>`_
22 24

  
25
For older developement (Ganeti < 2.4) ``docbook`` was used instead
26
``pandoc``.
27

  
23 28
Note that for pylint, at the current moment the following versions
24 29
must be used::
25 30

  
......
27 32
    pylint 0.21.1,
28 33
    astng 0.20.1, common 0.50.3
29 34

  
35
The same with pep8, other versions may give you errors::
36

  
37
     $ pep8 --version
38
     0.6.1
39

  
30 40
To generate unittest coverage reports (``make coverage``), `coverage
31 41
<http://pypi.python.org/pypi/coverage>`_ needs to be installed.
32 42

  
43
Installation of all dependencies listed here::
44

  
45
     $ apt-get install python-setuptools
46
     $ apt-get install pandoc python-epydoc graphviz
47
     $ cd / && sudo easy_install \
48
               sphinx \
49
               logilab-astng==0.20.1 \
50
               logilab-common==0.50.3 \
51
               pylint==0.21.1 \
52
               pep8==0.6.1 \
53
               coverage
54

  
33 55
For Haskell development, again all things from the quick install
34 56
document, plus:
35 57

  

Also available in: Unified diff