[28702] trunk/base/HACKING

[markd at macports.org]

macports-dev at lists.macosforge.org writes:
>Added: trunk/base/HACKING (0 => 28702)
>
>
>--- 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.

I think that separately sprinkling documentation around in svn is
something that shouldn't be done anymore. They are parallel documentation
trains. I think they should be put into Trac tickets for inclusion in
official docs, which are the guide and man pages.  I just included some
things from base/doc/INTERNALS into the guide, and it should really be
deleted now.  An email in a few minutes will spell out more details.

Mark