[38337] trunk/doc-new/guide/xml/using.xml

[simon at macports.org]

Revision: 38337
          http://trac.macosforge.org/projects/macports/changeset/38337
Author:   simon at macports.org
Date:     2008-07-16 03:22:16 -0700 (Wed, 16 Jul 2008)
Log Message:
-----------
doc-new: Added description for "port lint".

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

Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml	2008-07-16 10:21:58 UTC (rev 38336)
+++ trunk/doc-new/guide/xml/using.xml	2008-07-16 10:22:16 UTC (rev 38337)
@@ -333,6 +333,33 @@
 
       <para></para>
     </section>
+
+    <section id="using.port.lint">
+      <title>lint</title>
+
+      <para>The lint option checks if the Portfile conforms to the MacPorts
+      standards specified in <link linkend="development">Portfile
+      Development</link>.</para>
+
+      <para>If a Portfile validates fine the following message is
+      shown.</para>
+
+      <programlisting><prompt>%%</prompt> <userinput>port lint chemtool</userinput></programlisting>
+
+      <screen>--->  Verifying Portfile for chemtool
+--->  0 errors and 0 warnings found.</screen>
+
+      <para>Otherwise the warnings and errors are listed.</para>
+
+      <programlisting><prompt>%%</prompt> <userinput>port lint KeyArcher</userinput></programlisting>
+
+      <screen>--->  Verifying Portfile for KeyArcher
+Warning: Line 2 should be a newline (after RCS tag)
+Warning: Line 5 has trailing whitespace before newline
+Error: Missing required variable: platforms
+--->  1 errors and 2 warnings found.
+</screen>
+    </section>
   </section>
 
   <section id="using.variants">
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20080716/c708e561/attachment.html