Changeset 28011 for trunk/doc


Ignore:
Timestamp:
Aug 18, 2007, 1:15:03 AM (12 years ago)
Author:
markd@…
Message:

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

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/new/xml/portfiledev.xml

    r27991 r28011  
    202202        <para>Port maintainers</para>
    203203
    204         <para>A port's maintainer is who takes responsibility for the port;
    205         ports that are not maintained and fair game to be modified by any
    206         committer use <email>nomaintainer@macports.org</email>.</para>
    207 
    208         <programlisting>maintainers       joebob@macports.org</programlisting>
     204        <para>A port's maintainer is a person who takes responsibility for
     205        keeping the port up-to-date. To avoid spam, email addresses are often
     206        hidden. To hide email addresses from spambots, use these
     207        conventions.</para>
     208
     209        <itemizedlist>
     210          <listitem>
     211            <para>For addresses in domain @macports.org, simply omit the
     212            domain name.</para>
     213          </listitem>
     214
     215          <listitem>
     216            <para>For addresses in other domains, say
     217            <email>samj@somedomain.org</email>, use the convention
     218            somedomain.org:samj to specify the address.</para>
     219          </listitem>
     220        </itemizedlist>
     221
     222        <para>In the example below, the email addresses
     223        <email>joebob@macports.org</email> and
     224        <email>julesverne@somedomain.org</email> are hidden using this
     225        convention.</para>
     226
     227        <programlisting>maintainers       joebob \
     228                  somedomain.org:julesverne</programlisting>
     229
     230        <note>
     231          <para>The address <email>nomaintainer@macports.org</email>
     232          designates a port that may be modified by any committer.</para>
     233        </note>
    209234      </listitem>
    210235
     
    286311version                 1.2.23
    287312categories              net
    288 maintainers             joebob@macports.org
     313maintainers             joebob
    289314description             Round Robin Database
    290315long_description        RRDtool is a system to store and display time-series data
     
    608633    <para>This section contains practical guidelines for creating Portfiles
    609634    that install smoothly and provide consistency between ports.</para>
     635
     636    <section>
     637      <title>Don't Overwrite Config Files</title>
     638
     639      <para></para>
     640    </section>
     641
     642    <section>
     643      <title>Install Docs and Examples</title>
     644
     645      <para></para>
     646    </section>
     647
     648    <section>
     649      <title>Provide User Messages</title>
     650
     651      <para></para>
     652    </section>
    610653  </section>
    611654</chapter>
Note: See TracChangeset for help on using the changeset viewer.