Commit 9110fb4a authored by Santi Raffa's avatar Santi Raffa Committed by Petr Pudlak

Add code style document to documentation

The Ganeti code style has been stored on the project wiki at:

  https://code.google.com/p/ganeti/wiki/StyleGuide
  https://code.google.com/p/ganeti/wiki/HaskellStyleGuide

This commit combines the two pages into an .rst file with minimal
formatting and language changes. Note that the style guide introduced
in this commit does not fit the code base in a number of ways,
including:

* Some Haskell files have lines longer than 78 characters
* Some Haskell files have trailing whitespace
* Some Python docstring initial sentences lack punctuation at the end

The decision to either change the offending lines to fit the guidelines,
to change the guidelines to fit the codebase or to simply ignore the
discrepancies is left for other commits to solve.
Signed-off-by: default avatarSanti Raffa <rsanti@google.com>
Signed-off-by: default avatarPetr Pudlak <pudlak@google.com>
Reviewed-by: default avatarPetr Pudlak <pudlak@google.com>
parent ed748771
......@@ -555,6 +555,7 @@ docinput = \
doc/design-upgrade.rst \
doc/design-virtual-clusters.rst \
doc/design-x509-ca.rst \
doc/dev-codestyle.rst \
doc/devnotes.rst \
doc/glossary.rst \
doc/hooks.rst \
......
This diff is collapsed.
......@@ -116,6 +116,11 @@ the installed and developed versions are very similar, and/or if
PYTHONPATH is customised correctly). As such, in general it's
recommended to use a "clean" machine for ganeti development.
Style guide
-----------
Please adhere to the :doc:`dev-codestyle` while writing code for Ganeti.
Haskell development notes
-------------------------
......
......@@ -137,6 +137,7 @@ Draft designs
design-upgrade.rst
design-virtual-clusters.rst
devnotes.rst
dev-codestyle.rst
glossary.rst
hooks.rst
iallocator.rst
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment