[28702] trunk/base/HACKING

[source_changes at macosforge.org]

Revision: 28702
          http://trac.macosforge.org/projects/macports/changeset/28702
Author:   eridius at macports.org
Date:     2007-09-07 11:34:33 -0700 (Fri, 07 Sep 2007)

Log Message:
-----------
Add basic HACKING file with my rules as documented on the list. Include Blair's suggestion for Makefiles

Added Paths:
-----------
    trunk/base/HACKING

Added: trunk/base/HACKING
===================================================================
--- trunk/base/HACKING	                        (rev 0)
+++ trunk/base/HACKING	2007-09-07 18:34:33 UTC (rev 28702)
@@ -0,0 +1,13 @@
+Whitespace rules as discussed on the list:
+
+* All source code files MUST use soft tabs at a tabstop of 4. No hard tabs are allowed.
+* All source code files SHOULD have the following as the first line of the file:
+       # -*- Mode: Tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:et:sw=4:ts=4:sts=4
+   This is a modeline that works for both emacs and vim.
+* Portfiles SHOULD use soft tabs at a tabstop of 4, but implementation of this is left up to the discretion of the maintainer.
+* Portfiles SHOULD use the given modeline
+* Makefiles MUST use tabs as it is required by the syntax. Makefiles SHOULD use a tab stop of 8.
+* Makefiles MAY use a modeline. The following works for emacs and vim:
+       # -*- Mode: Makefile; tab-width: 8; indent-tabs-mode: t -*- vim:noet:sw=8:ts=8
+* All other files (documentation, etc) SHOULD use soft tabs at a tabstop of 4 if the document format allows.
+* All other files (documentation, etc) SHOULD NOT use a modeline as it is probably meant for human consumption.

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070907/d3dd5d36/attachment.html