root / doc / devnotes.rst @ 0232b768
History | View | Annotate | Download (5.4 kB)
1 | 832aef24 | Michael Hanselmann | Developer notes |
---|---|---|---|
2 | 832aef24 | Michael Hanselmann | =============== |
3 | 832aef24 | Michael Hanselmann | |
4 | 727ee1ec | Iustin Pop | .. highlight:: shell-example |
5 | 727ee1ec | Iustin Pop | |
6 | b2fc7ea1 | Michael Hanselmann | Build dependencies |
7 | b2fc7ea1 | Michael Hanselmann | ------------------ |
8 | b2fc7ea1 | Michael Hanselmann | |
9 | fc6075dd | Agata Murawska | Most dependencies from :doc:`install-quick`, including ``qemu-img`` |
10 | fc6075dd | Agata Murawska | (marked there as optional) plus (for Python): |
11 | cbf3d64b | Michael Hanselmann | |
12 | c27ba1cc | Michael Hanselmann | - `GNU make <http://www.gnu.org/software/make/>`_ |
13 | c27ba1cc | Michael Hanselmann | - `GNU tar <http://www.gnu.org/software/tar/>`_ |
14 | c27ba1cc | Michael Hanselmann | - `Gzip <http://www.gnu.org/software/gzip/>`_ |
15 | 18e2b6e4 | Iustin Pop | - `pandoc <http://johnmacfarlane.net/pandoc/>`_ |
16 | fc6075dd | Agata Murawska | - `python-epydoc <http://epydoc.sourceforge.net/>`_ |
17 | c27ba1cc | Michael Hanselmann | - `python-sphinx <http://sphinx.pocoo.org/>`_ |
18 | fc6075dd | Agata Murawska | (tested with version 1.1.3) |
19 | c27ba1cc | Michael Hanselmann | - `graphviz <http://www.graphviz.org/>`_ |
20 | 1de45c78 | Guido Trotter | - the `en_US.UTF-8` locale must be enabled on the system |
21 | 77a180f6 | Iustin Pop | - `pylint <http://www.logilab.org/857>`_ and its associated |
22 | 77a180f6 | Iustin Pop | dependencies |
23 | 08366664 | Michael Hanselmann | - `pep8 <https://github.com/jcrocholl/pep8/>`_ |
24 | 77a180f6 | Iustin Pop | |
25 | fc6075dd | Agata Murawska | For older developement (Ganeti < 2.4) ``docbook`` was used instead |
26 | fc6075dd | Agata Murawska | ``pandoc``. |
27 | fc6075dd | Agata Murawska | |
28 | 77a180f6 | Iustin Pop | Note that for pylint, at the current moment the following versions |
29 | 727ee1ec | Iustin Pop | must be used:: |
30 | 77a180f6 | Iustin Pop | |
31 | 77a180f6 | Iustin Pop | $ pylint --version |
32 | 77a180f6 | Iustin Pop | pylint 0.21.1, |
33 | 77a180f6 | Iustin Pop | astng 0.20.1, common 0.50.3 |
34 | b2fc7ea1 | Michael Hanselmann | |
35 | fc6075dd | Agata Murawska | The same with pep8, other versions may give you errors:: |
36 | fc6075dd | Agata Murawska | |
37 | fc6075dd | Agata Murawska | $ pep8 --version |
38 | 5ae4945a | Iustin Pop | 1.2 |
39 | fc6075dd | Agata Murawska | |
40 | 27e336af | Michael Hanselmann | To generate unittest coverage reports (``make coverage``), `coverage |
41 | 27e336af | Michael Hanselmann | <http://pypi.python.org/pypi/coverage>`_ needs to be installed. |
42 | 27e336af | Michael Hanselmann | |
43 | fc6075dd | Agata Murawska | Installation of all dependencies listed here:: |
44 | fc6075dd | Agata Murawska | |
45 | fc6075dd | Agata Murawska | $ apt-get install python-setuptools |
46 | fc6075dd | Agata Murawska | $ apt-get install pandoc python-epydoc graphviz |
47 | fc6075dd | Agata Murawska | $ cd / && sudo easy_install \ |
48 | fc6075dd | Agata Murawska | sphinx \ |
49 | fc6075dd | Agata Murawska | logilab-astng==0.20.1 \ |
50 | fc6075dd | Agata Murawska | logilab-common==0.50.3 \ |
51 | fc6075dd | Agata Murawska | pylint==0.21.1 \ |
52 | 5ae4945a | Iustin Pop | pep8==1.2 \ |
53 | fc6075dd | Agata Murawska | coverage |
54 | fc6075dd | Agata Murawska | |
55 | 77a180f6 | Iustin Pop | For Haskell development, again all things from the quick install |
56 | 77a180f6 | Iustin Pop | document, plus: |
57 | 77a180f6 | Iustin Pop | |
58 | 77a180f6 | Iustin Pop | - `haddock <http://www.haskell.org/haddock/>`_, documentation |
59 | 77a180f6 | Iustin Pop | generator (equivalent to epydoc for Python) |
60 | 77a180f6 | Iustin Pop | - `HsColour <http://hackage.haskell.org/package/hscolour>`_, again |
61 | 77a180f6 | Iustin Pop | used for documentation (it's source-code pretty-printing) |
62 | 77a180f6 | Iustin Pop | - `hlint <http://community.haskell.org/~ndm/hlint/>`_, a source code |
63 | 3603605a | Iustin Pop | linter (equivalent to pylint for Python), recommended version 1.8 or |
64 | 3603605a | Iustin Pop | above (tested with 1.8.15) |
65 | 77a180f6 | Iustin Pop | - the `QuickCheck <http://hackage.haskell.org/package/QuickCheck>`_ |
66 | 8e4f6d56 | Iustin Pop | library, version 2.x |
67 | 95f6c931 | Iustin Pop | - the `HUnit <http://hunit.sourceforge.net/>`_ library (tested with |
68 | 95f6c931 | Iustin Pop | 1.2.x) |
69 | 95f6c931 | Iustin Pop | - the `test-framework |
70 | 95f6c931 | Iustin Pop | <http://batterseapower.github.com/test-framework/>`_ libraries, |
71 | 95f6c931 | Iustin Pop | tested versions: ``test-framework``: 0.6, ``test-framework-hunit``: |
72 | 95f6c931 | Iustin Pop | 0.2.7, ``test-framework-quickcheck2``: 0.2.12 |
73 | fd0bc853 | Iustin Pop | - ``hpc``, which comes with the compiler, so you should already have |
74 | fd0bc853 | Iustin Pop | it |
75 | 727ee1ec | Iustin Pop | - `shelltestrunner <http://joyful.com/shelltestrunner>`_, used for |
76 | 95f6c931 | Iustin Pop | running shell-based unit-tests |
77 | 727ee1ec | Iustin Pop | |
78 | 727ee1ec | Iustin Pop | Under Debian Wheezy or later, these can be installed (on top of the |
79 | 727ee1ec | Iustin Pop | required ones from the quick install document) via:: |
80 | fd0bc853 | Iustin Pop | |
81 | 95f6c931 | Iustin Pop | $ apt-get install libghc-quickcheck2-dev libghc-hunit-dev \ |
82 | 95f6c931 | Iustin Pop | libghc-test-framework-dev \ |
83 | 95f6c931 | Iustin Pop | libghc-test-framework-quickcheck2-dev \ |
84 | 95f6c931 | Iustin Pop | libghc-test-framework-hunit-dev \ |
85 | 95f6c931 | Iustin Pop | hscolour hlint |
86 | fd0bc853 | Iustin Pop | |
87 | 727ee1ec | Iustin Pop | Or alternatively via ``cabal``:: |
88 | 727ee1ec | Iustin Pop | |
89 | 21a5e56c | Iustin Pop | $ cabal install QuickCheck HUnit \ |
90 | 21a5e56c | Iustin Pop | test-framework test-framework-quickcheck2 test-framework-hunit \ |
91 | 21a5e56c | Iustin Pop | hscolour hlint shelltestrunner |
92 | 77a180f6 | Iustin Pop | |
93 | b2fc7ea1 | Michael Hanselmann | |
94 | 832aef24 | Michael Hanselmann | Configuring for development |
95 | 832aef24 | Michael Hanselmann | --------------------------- |
96 | 832aef24 | Michael Hanselmann | |
97 | d17e74b4 | Iustin Pop | Run the following command (only use ``PYTHON=...`` if you need to use a |
98 | d17e74b4 | Iustin Pop | different python version):: |
99 | d17e74b4 | Iustin Pop | |
100 | 727ee1ec | Iustin Pop | $ ./autogen.sh && \ |
101 | 727ee1ec | Iustin Pop | ./configure --prefix=/usr/local --sysconfdir=/etc --localstatedir=/var |
102 | 558fd122 | Michael Hanselmann | |
103 | ef958f2a | Iustin Pop | Haskell development notes |
104 | ef958f2a | Iustin Pop | ------------------------- |
105 | ef958f2a | Iustin Pop | |
106 | ef958f2a | Iustin Pop | There are a few things which can help writing or debugging the Haskell |
107 | ef958f2a | Iustin Pop | code. |
108 | ef958f2a | Iustin Pop | |
109 | ef958f2a | Iustin Pop | You can run the Haskell linter :command:`hlint` via:: |
110 | ef958f2a | Iustin Pop | |
111 | 727ee1ec | Iustin Pop | $ make hlint |
112 | ef958f2a | Iustin Pop | |
113 | 3603605a | Iustin Pop | This is not enabled by default (as the htools component is |
114 | 3603605a | Iustin Pop | optional). The above command will generate both output on the terminal |
115 | 3603605a | Iustin Pop | and, if any warnings are found, also an HTML report at |
116 | ef958f2a | Iustin Pop | ``doc/hs-lint.html``. |
117 | ef958f2a | Iustin Pop | |
118 | ef958f2a | Iustin Pop | When writing or debugging TemplateHaskell code, it's useful to see |
119 | ef958f2a | Iustin Pop | what the splices are converted to. This can be done via:: |
120 | ef958f2a | Iustin Pop | |
121 | 727ee1ec | Iustin Pop | $ make HEXTRA="-ddump-splices" |
122 | ef958f2a | Iustin Pop | |
123 | ef958f2a | Iustin Pop | Due to the way TemplateHaskell works, it's not straightforward to |
124 | c7ec3025 | Iustin Pop | build profiling code. The recommended way is to run ``make hs-prof``, |
125 | c7ec3025 | Iustin Pop | or alternatively the manual sequence is:: |
126 | ef958f2a | Iustin Pop | |
127 | 727ee1ec | Iustin Pop | $ make clean |
128 | 727ee1ec | Iustin Pop | $ make htools/htools HEXTRA="-osuf .o" |
129 | 727ee1ec | Iustin Pop | $ rm htools/htools |
130 | 727ee1ec | Iustin Pop | $ make htools/htools HEXTRA="-osuf .prof_o -prof -auto-all" |
131 | ef958f2a | Iustin Pop | |
132 | ef958f2a | Iustin Pop | This will build the binary twice, per the TemplateHaskell |
133 | ef958f2a | Iustin Pop | documentation, the second one with profiling enabled. |
134 | ef958f2a | Iustin Pop | |
135 | 94338f0a | Michael Hanselmann | |
136 | 94338f0a | Michael Hanselmann | Packaging notes |
137 | 94338f0a | Michael Hanselmann | =============== |
138 | 94338f0a | Michael Hanselmann | |
139 | 77865fb4 | Gintautas Miliauskas | Ganeti is mostly developed and tested on `Debian |
140 | 94338f0a | Michael Hanselmann | <http://www.debian.org/>`_-based distributions, while still keeping |
141 | 77865fb4 | Gintautas Miliauskas | adaptability to other Linux distributions in mind. |
142 | 94338f0a | Michael Hanselmann | |
143 | 94338f0a | Michael Hanselmann | The ``doc/examples/`` directory contains a number of potentially useful |
144 | 94338f0a | Michael Hanselmann | scripts and configuration files. Some of them might need adjustment |
145 | 94338f0a | Michael Hanselmann | before use. |
146 | 94338f0a | Michael Hanselmann | |
147 | 94338f0a | Michael Hanselmann | ``daemon-util`` |
148 | 94338f0a | Michael Hanselmann | --------------- |
149 | 94338f0a | Michael Hanselmann | |
150 | 94338f0a | Michael Hanselmann | This script, in the source code as ``daemons/daemon-util.in``, is used |
151 | 94338f0a | Michael Hanselmann | to start/stop Ganeti and do a few other things related to system |
152 | 77a180f6 | Iustin Pop | daemons. It is recommended to use ``daemon-util`` also from the system's |
153 | 94338f0a | Michael Hanselmann | init scripts. That way the code starting and stopping daemons is shared |
154 | 94338f0a | Michael Hanselmann | and future changes have to be made in only one place. |
155 | 94338f0a | Michael Hanselmann | |
156 | 94338f0a | Michael Hanselmann | ``daemon-util`` reads extra arguments from variables (``*_ARGS``) in |
157 | 94338f0a | Michael Hanselmann | ``/etc/default/ganeti``. When modifying ``daemon-util``, keep in mind to |
158 | 94338f0a | Michael Hanselmann | not remove support for the ``EXTRA_*_ARGS`` variables for starting |
159 | 94338f0a | Michael Hanselmann | daemons. Some parts of Ganeti use them to pass additional arguments when |
160 | 94338f0a | Michael Hanselmann | starting a daemon. |
161 | 94338f0a | Michael Hanselmann | |
162 | 94338f0a | Michael Hanselmann | The ``reload_ssh_keys`` function can be adjusted to use another command |
163 | 94338f0a | Michael Hanselmann | for reloading the OpenSSH daemon's host keys. |
164 | 94338f0a | Michael Hanselmann | |
165 | 558fd122 | Michael Hanselmann | .. vim: set textwidth=72 : |