X-Git-Url: https://code.grnet.gr/git/ganeti-local/blobdiff_plain/21a5e56cb99eb7bf14ae2c3e557b629d33289312..5e09a3098d47371b7d105e7f5f571a72532a03d7:/doc/devnotes.rst diff --git a/doc/devnotes.rst b/doc/devnotes.rst index 014f2cd..c5594e8 100644 --- a/doc/devnotes.rst +++ b/doc/devnotes.rst @@ -132,13 +132,44 @@ or alternatively the manual sequence is:: This will build the binary twice, per the TemplateHaskell documentation, the second one with profiling enabled. +The binary files generated by compilation and the profiling/coverage +files can "break" tab-completion in the sources; they can be ignored, +for example, in bash via ``.bashrc``:: + + FIGNORE='.o:.hi:.prof_o:.tix' + +or in emacs via ``completion-ignored-extensions`` (run ``M-x +customize-var completion-ignored-extensions``). + +Running individual tests +~~~~~~~~~~~~~~~~~~~~~~~~ + +When developing code, running the entire test suite can be +slow. Running individual tests is possible easily for unit-tests, less +so for shell-tests (but these are faster, so it shouldn't be needed). + +For Python tests:: + + $ export PYTHONPATH=$PWD + $ python ./test/ganeti.%mytest% + +For Haskell tests:: + + $ make htest/test && ./htest/test -t %pattern% + +Where ``pattern`` can be a simple test pattern (e.g. ``comma``, +matching any test whose name contains ``comma``), a test pattern +denoting a group (ending with a slash, e.g. ``Utils/``), or more +complex glob pattern. For more details, see the documentation (on the +`test-framework homepage +`_). Packaging notes =============== -Ganeti is mostly developped and tested on `Debian +Ganeti is mostly developed and tested on `Debian `_-based distributions, while still keeping -adoptability to other Linux distributions in mind. +adaptability to other Linux distributions in mind. The ``doc/examples/`` directory contains a number of potentially useful scripts and configuration files. Some of them might need adjustment