Revision 77a180f6 doc/devnotes.rst

b/doc/devnotes.rst
4 4
Build dependencies
5 5
------------------
6 6

  
7
Most dependencies from :doc:`install-quick`, plus:
7
Most dependencies from :doc:`install-quick`, plus (for Python):
8 8

  
9 9
- `GNU make <http://www.gnu.org/software/make/>`_
10 10
- `GNU tar <http://www.gnu.org/software/tar/>`_
......
14 14
  (tested with version 0.6.1)
15 15
- `graphviz <http://www.graphviz.org/>`_
16 16
- the `en_US.UTF-8` locale must be enabled on the system
17
- `pylint <http://www.logilab.org/857>`_ and its associated
18
  dependencies
19

  
20
Note that for pylint, at the current moment the following versions
21
need to be used::
22

  
23
    $ pylint --version
24
    pylint 0.21.1,
25
    astng 0.20.1, common 0.50.3
17 26

  
18 27
To generate unittest coverage reports (``make coverage``), `coverage
19 28
<http://pypi.python.org/pypi/coverage>`_ needs to be installed.
20 29

  
30
For Haskell development, again all things from the quick install
31
document, plus:
32

  
33
- `haddock <http://www.haskell.org/haddock/>`_, documentation
34
  generator (equivalent to epydoc for Python)
35
- `HsColour <http://hackage.haskell.org/package/hscolour>`_, again
36
  used for documentation (it's source-code pretty-printing)
37
- `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code
38
  linter (equivalent to pylint for Python)
39
- the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_
40
  library, version 1.x
41
- ``hpc``, which comes with the compiler, so you should already have it
42

  
21 43

  
22 44
Configuring for development
23 45
---------------------------
......
47 69

  
48 70
This script, in the source code as ``daemons/daemon-util.in``, is used
49 71
to start/stop Ganeti and do a few other things related to system
50
daemons. Is is recommended to use ``daemon-util`` also from the system's
72
daemons. It is recommended to use ``daemon-util`` also from the system's
51 73
init scripts. That way the code starting and stopping daemons is shared
52 74
and future changes have to be made in only one place.
53 75

  

Also available in: Unified diff