aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGerald Combs <gerald@wireshark.org>2006-11-16 18:28:09 +0000
committerGerald Combs <gerald@wireshark.org>2006-11-16 18:28:09 +0000
commit50998dea361ae28434de1b3ba0098bde555b6126 (patch)
tree30fe86bd26ad9a3f234a26356f4e6197868f5650 /doc
parent8aa44209fa43181ed5797560c858417cc636fe34 (diff)
Add comments to the indentation style section.
svn path=/trunk/; revision=19910
Diffstat (limited to 'doc')
-rw-r--r--doc/README.developer29
1 files changed, 18 insertions, 11 deletions
diff --git a/doc/README.developer b/doc/README.developer
index 14d0873fe3..045eb9fd2f 100644
--- a/doc/README.developer
+++ b/doc/README.developer
@@ -575,17 +575,24 @@ trying to keep things consistent for other users.
1.1.5 White space convention.
-Avoid using tab expansions different from 8 spaces, as not all text editors in
-use by the developers support this.
-
-When creating a new file, you are free to choose an indentation logic. Most of
-the files in Wireshark tend to use 2-space or 4-space indentation. You are
-encouraged to write a short comment on the indentation logic at the beginning
-of this new file.
-
-When editing an existing file, try following the existing indentation logic and
-even if it very tempting, never ever use a restyler/reindenter utility on an
-existing file.
+Avoid using tab expansions different from 8 column widths, as not all
+text editors in use by the developers support this. For a detailed
+discussion of tabs, spaces, and indentation, see
+
+ http://www.jwz.org/doc/tabs-vs-spaces.html
+
+When creating a new file, you are free to choose an indentation logic.
+Most of the files in Wireshark tend to use 2-space or 4-space
+indentation. You are encouraged to write a short comment on the
+indentation logic at the beginning of this new file, especially if
+you're using non-mod-8 tabs. The tabs-vs-spaces document above provides
+examples of Emacs and vi modelines for this purpose.
+
+When editing an existing file, try following the existing indentation
+logic and even if it very tempting, never ever use a restyler/reindenter
+utility on an existing file. If you run across wildly varying
+indentation styles within the same file, it might be helpful to send a
+note to wireshark-dev for guidance.
1.2 Skeleton code.