Kaydet (Commit) f9265535 authored tarafından Lex Trotman's avatar Lex Trotman

Mention trailing whitespace in style

üst cc045b67
...@@ -196,6 +196,9 @@ Style ...@@ -196,6 +196,9 @@ Style
* We use a tab width of 4 and indent completely with tabs not spaces. * We use a tab width of 4 and indent completely with tabs not spaces.
Note the documentation files use (4) spaces instead, so you may want Note the documentation files use (4) spaces instead, so you may want
to use the 'Detect from file' indent pref. to use the 'Detect from file' indent pref.
* Do not add whitespace at the end of lines, this adds to commit noise.
When editing with Geany set preference files->Strip trailing spaces
and tabs.
* Use the multiline comment ``/* */`` to comment small blocks of code, * Use the multiline comment ``/* */`` to comment small blocks of code,
functions descriptions or longer explanations of code, etc. C++ single functions descriptions or longer explanations of code, etc. C++ single
line comments will cause portability issues. The more comments are in line comments will cause portability issues. The more comments are in
...@@ -221,6 +224,8 @@ Style ...@@ -221,6 +224,8 @@ Style
A few of the above can be done with the Git A few of the above can be done with the Git
``scripts/fix-alignment.pl``, but it is quite dumb and it's much better ``scripts/fix-alignment.pl``, but it is quite dumb and it's much better
to write it correctly in the first place. to write it correctly in the first place.
``scripts/rstrip-whitespace.py`` just removes trailing whitespace.
.. below tabs should be used, but spaces are required for reST. .. below tabs should be used, but spaces are required for reST.
......
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