[38326] trunk/doc-new/guide/xml/portfiledev.xml

[simon at macports.org]

Revision: 38326
          http://trac.macosforge.org/projects/macports/changeset/38326
Author:   simon at macports.org
Date:     2008-07-15 15:05:30 -0700 (Tue, 15 Jul 2008)
Log Message:
-----------
doc-new: Fixed description of use of modeline, closes #15406.

Modified Paths:
--------------
    trunk/doc-new/guide/xml/portfiledev.xml

Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml	2008-07-15 20:58:33 UTC (rev 38325)
+++ trunk/doc-new/guide/xml/portfiledev.xml	2008-07-15 22:05:30 UTC (rev 38326)
@@ -88,11 +88,23 @@
 
     <orderedlist>
       <listitem>
+        <para>Modeline</para>
+
+        <para>This should be the first line of a Portfile. It sets the correct
+        editing options for vim and emacs. See <link
+        linkend="development.practices.portstyle">Port Style</link> for more
+        information. Its use is optional and up to the port maintainer.</para>
+
+        <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- vim:fenc=utf-8:ft=tcl:et:sw=4:ts=4:sts=4</programlisting>
+      </listitem>
+
+      <listitem>
         <para>Subversion ID tag line</para>
 
-        <para>The first line of a new Portfile must be set as shown. When a
-        port is committed to subversion, ID tags are expanded to include the
-        last person to commit and the commit time.</para>
+        <para>This must be the second line (or if the modeline is not used the
+        first) in a Portfile. When a port is committed to subversion, ID tags
+        are expanded to include the last person to commit and the commit
+        time.</para>
 
         <programlisting># $Id$</programlisting>
       </listitem>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20080715/bb5b1490/attachment.html