Changes between Version 48 and Version 49 of Submitting/C

Timestamp:

Jul 21, 2014, 6:46:19 AM (10 years ago)

Author:

wenzeslaus

Comment:

explain indetation in a better way

Submitting/C

@@ -261 +261 @@
 == Indentation ==
 
-To promote a consistent coding style, please use the "indent" program on all new C modules using the following switches:
+To promote a consistent coding style for whitespace (spaces, tabs, newlines), please use the `indent` tool on all new C files using the following switches:
 {{{
      $ indent -bad -bap -bbb -br -bli0 -bls -cli0 -ncs -fc1 -hnl -i4 \
@@ -267 +267 @@
       -npsl -nsc -nsob -saf -sai -saw -sbi0 -ss -ts8 -ut main.c
 }}}
-    Existing code should not be re-indented except in extreme cases, as this will make "diff" comparisons with older versions impossible. If indent is needed, do not check in any changes other than the indentation in the same commit! Do add the indent switches and any indent warning messages to the SVN log. Any change or fix mixed in with an indent is very hard to track making it hard for others to follow the change or fix any new bugs. For your convenience use the source:grass/trunk/tools/grass_indent.sh script.
-
+
+Existing code should not be re-indented as this will make "diff" comparisons with older versions impossible. In extreme cases, when run of `indent` tool is necessary, do not commit (check in) any changes other than the indentation in the same commit. Additionally, add the `indent` tool switches and any indent warning messages to the SVN commit message (SVN log). Any change or fix mixed in with an indentation is very hard to track making it hard for others to follow the change, fix any new bugs or track the origin of particular lines (`svn diff --ignore-space-change` is helpful in this case, but does not solve the problem).
+
+For your convenience use the [source:grass/trunk/tools/grass_indent.sh tools/grass_indent.sh] script available in GRASS source code.
 == Compilation ==