[28011] trunk/doc/guide/new/xml/portfiledev.xml

[source_changes at macosforge.org]

Revision: 28011
          http://trac.macosforge.org/projects/macports/changeset/28011
Author:   markd at macports.org
Date:     2007-08-17 18:15:03 -0700 (Fri, 17 Aug 2007)

Log Message:
-----------
Closes #12511. Add instructions on how to hide email addresses.  Add some categories to 
"Portfile Best Practices".

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

Modified: trunk/doc/guide/new/xml/portfiledev.xml
===================================================================
--- trunk/doc/guide/new/xml/portfiledev.xml	2007-08-17 19:37:22 UTC (rev 28010)
+++ trunk/doc/guide/new/xml/portfiledev.xml	2007-08-18 01:15:03 UTC (rev 28011)
@@ -201,11 +201,36 @@
       <listitem>
         <para>Port maintainers</para>
 
-        <para>A port's maintainer is who takes responsibility for the port;
-        ports that are not maintained and fair game to be modified by any
-        committer use <email>nomaintainer at macports.org</email>.</para>
+        <para>A port's maintainer is a person who takes responsibility for
+        keeping the port up-to-date. To avoid spam, email addresses are often
+        hidden. To hide email addresses from spambots, use these
+        conventions.</para>
 
-        <programlisting>maintainers       joebob at macports.org</programlisting>
+        <itemizedlist>
+          <listitem>
+            <para>For addresses in domain @macports.org, simply omit the
+            domain name.</para>
+          </listitem>
+
+          <listitem>
+            <para>For addresses in other domains, say
+            <email>samj at somedomain.org</email>, use the convention
+            somedomain.org:samj to specify the address.</para>
+          </listitem>
+        </itemizedlist>
+
+        <para>In the example below, the email addresses
+        <email>joebob at macports.org</email> and
+        <email>julesverne at somedomain.org</email> are hidden using this
+        convention.</para>
+
+        <programlisting>maintainers       joebob \
+                  somedomain.org:julesverne</programlisting>
+
+        <note>
+          <para>The address <email>nomaintainer at macports.org</email>
+          designates a port that may be modified by any committer.</para>
+        </note>
       </listitem>
 
       <listitem>
@@ -285,7 +310,7 @@
 name                    rrdtool
 version                 1.2.23
 categories              net
-maintainers             joebob at macports.org
+maintainers             joebob
 description             Round Robin Database
 long_description        RRDtool is a system to store and display time-series data
 homepage                http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/
@@ -607,5 +632,23 @@
 
     <para>This section contains practical guidelines for creating Portfiles
     that install smoothly and provide consistency between ports.</para>
+
+    <section>
+      <title>Don't Overwrite Config Files</title>
+
+      <para></para>
+    </section>
+
+    <section>
+      <title>Install Docs and Examples</title>
+
+      <para></para>
+    </section>
+
+    <section>
+      <title>Provide User Messages</title>
+
+      <para></para>
+    </section>
   </section>
 </chapter>
\ No newline at end of file

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