Changeset 27359 for trunk/doc


Ignore:
Timestamp:
Jul 31, 2007, 4:13:38 AM (12 years ago)
Author:
markd@…
Message:

Markup changes and minor cleanup of text.

File:
1 edited

Legend:

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

    r27339 r27359  
    4141      <itemizedlist>
    4242        <listitem>
    43           <para><emphasis>Short Summary:</emphasis> [port] [version] [concise
     43          <para><guilabel>Short Summary:</guilabel> [port] [version] [concise
    4444          description]</para>
    4545
     
    5353
    5454        <listitem>
    55           <para><emphasis>Type:</emphasis> There are two main types of
     55          <para><guilabel>Type:</guilabel> There are two main types of
    5656          tickets.</para>
    5757
    5858          <itemizedlist>
    5959            <listitem>
    60               <para>defect - The default; any port/MacPorts build/runtime
    61               failures and/or documentation corrections.</para>
    62             </listitem>
    63 
    64             <listitem>
    65               <para>enhancement - Tickets, with or without patches, created to
    66               enhance something that isn't failing its intended
    67               purpose.</para>
     60              <para><guimenu>defect</guimenu> - The default; any port/MacPorts
     61              build/runtime failures and/or documentation corrections.</para>
     62            </listitem>
     63
     64            <listitem>
     65              <para><guimenu>enhancement</guimenu> - Tickets, with or without
     66              patches, created to enhance something that isn't failing its
     67              intended purpose.</para>
    6868            </listitem>
    6969          </itemizedlist>
     
    7171
    7272        <listitem>
    73           <para><emphasis>Full Description:</emphasis> All details that might
     73          <para><guilabel>Full Description:</guilabel> All details that might
    7474          be relevant to someone reading the ticket. <ulink
    7575          url="http://trac.macports.org/projects/macports/wiki/WikiFormatting">Wiki
     
    7979
    8080        <listitem>
    81           <para><emphasis>Priority:</emphasis> Assign a priority level to the
     81          <para><guilabel>Priority:</guilabel> Assign a priority level to the
    8282          ticket.</para>
    8383
    8484          <itemizedlist>
    8585            <listitem>
    86               <para>High - For core MacPorts build/runtime failures and/or
    87               critical enhancement requests.</para>
    88             </listitem>
    89 
    90             <listitem>
    91               <para>Normal - The default. For normal port failures,
    92               non-critical enhancement requests, non-critical port
     86              <para><guimenu>High</guimenu> - For core MacPorts build/runtime
     87              failures and/or critical enhancement requests.</para>
     88            </listitem>
     89
     90            <listitem>
     91              <para><guimenu>Normal</guimenu> - The default. For normal port
     92              failures, non-critical enhancement requests, non-critical port
    9393              failures.</para>
    9494            </listitem>
    9595
    9696            <listitem>
    97               <para>Low - For mostly cosmetic improvements, documentation
    98               corrections/improvements, etc.</para>
    99             </listitem>
    100 
    101             <listitem>
    102               <para>Not set - Anything that doesn't fit the categories high,
     97              <para><guimenu>Low</guimenu> - For mostly cosmetic improvements,
     98              documentation corrections/improvements, etc.</para>
     99            </listitem>
     100
     101            <listitem>
     102              <para>Blank - Anything that doesn't fit the categories high,
    103103              normal, or low.</para>
    104104            </listitem>
     
    107107
    108108        <listitem>
    109           <para><emphasis>Component:</emphasis> Set what part of the MacPorts
     109          <para><guilabel>Component:</guilabel> Set what part of the MacPorts
    110110          project the ticket is to be filed against.</para>
    111111
    112112          <itemizedlist>
    113113            <listitem>
    114               <para>ports - Tickets related to ports.</para>
    115             </listitem>
    116 
    117             <listitem>
    118               <para>base - Tickets related to MacPorts base code.</para>
    119             </listitem>
    120 
    121             <listitem>
    122               <para>guide - Documentation errors, corrections, or patches to
    123               the MacPorts Guide.</para>
    124             </listitem>
    125 
    126             <listitem>
    127               <para>www - MacPorts website errors.</para>
    128             </listitem>
    129 
    130             <listitem>
    131               <para>infrastructure - Reserved for MacPorts Portmgr team
    132               members.</para>
     114              <para><guimenu>ports</guimenu> - Tickets related to
     115              ports.</para>
     116            </listitem>
     117
     118            <listitem>
     119              <para><guimenu>base</guimenu> - Tickets related to MacPorts base
     120              code.</para>
     121            </listitem>
     122
     123            <listitem>
     124              <para><guimenu>guide</guimenu> - Documentation errors,
     125              corrections, or patches to the MacPorts Guide.</para>
     126            </listitem>
     127
     128            <listitem>
     129              <para><guimenu>www</guimenu> - MacPorts website errors.</para>
     130            </listitem>
     131
     132            <listitem>
     133              <para><guimenu>infrastructure</guimenu> - Reserved for MacPorts
     134              Portmgr team members.</para>
    133135            </listitem>
    134136          </itemizedlist>
     
    136138
    137139        <listitem>
    138           <para><emphasis>Assign To:</emphasis> For tickets on ports, select
     140          <para><guilabel>Assign To:</guilabel> For tickets on ports, select
    139141          the port maintainer's email address (use <command>port info
    140142          &lt;portname&gt;</command>). If the maintainer's email address is
     
    144146
    145147        <listitem>
    146           <para><emphasis>Milestone:</emphasis> This is a ticket category that
     148          <para><guilabel>Milestone:</guilabel> This is a ticket category that
    147149          allows for search and sorting tickets efficiently.</para>
    148150
    149151          <itemizedlist>
    150152            <listitem>
    151               <para>Documentation - for tickets relating to the documentation
    152               for Macports, including the MacPorts guide, wiki and man
    153               pages.</para>
    154             </listitem>
    155 
    156             <listitem>
    157               <para>MacPorts core enhancements - for tickets requesting or
    158               providing improvements to the functionality of the MacPorts
    159               system.</para>
    160             </listitem>
    161 
    162             <listitem>
    163               <para>MacPorts core bugs - for tickets reporting or fixing bugs in
    164               the MacPorts system.</para>
    165             </listitem>
    166 
    167             <listitem>
    168               <para>MacPorts x.y - indicates tickets against the MacPorts core
    169                 that have been accepted and scheduled for inclusion or fixing in
    170                 the x.y MacPorts release series.  <emphasis>Note that this
    171                 milestone is therefore only to be applied to tickets by
    172                 MacPorts team members.  Users should file tickets against one
    173                 of the other milestones listed here.</emphasis>
    174                 </para>
    175             </listitem>
    176 
    177             <listitem>
    178               <para>Port Bugs - for tickets reporting or fixing bugs in ports
    179               provided by MacPorts.</para>
    180             </listitem>
    181 
    182             <listitem>
    183               <para>Port Enhancements - for submissions providing enhancements
    184               to ports provided by MacPorts.</para>
    185             </listitem>
    186 
    187             <listitem>
    188               <para>Port Requests - for requests for ports to be added to
    189               MacPorts.</para>
    190             </listitem>
    191 
    192             <listitem>
    193               <para>Port Submissions - for submissions that add a port to
    194               MacPorts.</para>
    195             </listitem>
    196 
    197             <listitem>
    198               <para>Port Updates - for submissions that update a port provided
    199               by MacPorts.</para>
     153              <para><guimenu>Documentation</guimenu> - for tickets relating to
     154              the documentation for Macports, including the MacPorts guide,
     155              wiki and man pages.</para>
     156            </listitem>
     157
     158            <listitem>
     159              <para><guimenu>MacPorts core enhancements</guimenu> - for
     160              tickets requesting or providing improvements to the
     161              functionality of the MacPorts system.</para>
     162            </listitem>
     163
     164            <listitem>
     165              <para><guimenu>MacPorts core bugs</guimenu> - for tickets
     166              reporting or fixing bugs in the MacPorts system.</para>
     167            </listitem>
     168
     169            <listitem>
     170              <para><guimenu>MacPorts x.y</guimenu> - indicates tickets
     171              against the MacPorts core that have been accepted and scheduled
     172              for inclusion or fixing in the x.y MacPorts release
     173              series.</para>
     174
     175              <note>
     176                <para>This milestone may only be applied by MacPorts team
     177                members.</para>
     178              </note>
     179            </listitem>
     180
     181            <listitem>
     182              <para><guimenu>Port Bugs</guimenu> - for tickets reporting or
     183              fixing bugs in ports provided by MacPorts.</para>
     184            </listitem>
     185
     186            <listitem>
     187              <para><guimenu>Port Enhancements</guimenu> - for submissions
     188              providing enhancements to ports provided by MacPorts.</para>
     189            </listitem>
     190
     191            <listitem>
     192              <para><guimenu>Port Requests</guimenu> - for requests for ports
     193              to be added to MacPorts.</para>
     194            </listitem>
     195
     196            <listitem>
     197              <para><guimenu>Port Submissions</guimenu> - for submissions that
     198              add a port to MacPorts.</para>
     199            </listitem>
     200
     201            <listitem>
     202              <para><guimenu>Port Updates</guimenu> - for submissions that
     203              update a port provided by MacPorts.</para>
    200204            </listitem>
    201205          </itemizedlist>
     
    203207
    204208        <listitem>
    205           <para><emphasis>Version:</emphasis> Select the MacPorts version you
     209          <para><guilabel>Version:</guilabel> Select the MacPorts version you
    206210          are using when it is applicable.</para>
    207211        </listitem>
    208212
    209213        <listitem>
    210           <para><emphasis>Keywords:</emphasis> Type any keywords that might
     214          <para><guilabel>Keywords:</guilabel> Type any keywords that might
    211215          help when searching for tickets (portname, type of problem,
    212216          etc).</para>
     
    214218
    215219        <listitem>
    216           <para><emphasis>Cc:</emphasis> The reporter should enter his or her
     220          <para><guilabel>Cc:</guilabel> The reporter should enter his or her
    217221          email address and the maintainer's email address to notify both
    218222          parties when updates to the ticket occur. This is important, because
     
    222226
    223227        <listitem>
    224           <para><emphasis>Attachments</emphasis> - Files may be attached only
     228          <para><guilabel>Attachments:</guilabel> Files may be attached only
    225229          after a ticket has been submitted. Once the ticket has been created
    226230          you will see the file attachment button.</para>
     
    315319
    316320      <para>If you have a port update or bugfix for a port you do not
    317       maintain, to respect the rights of the port maintainer you should folow
    318       the following protocol:</para>
     321      maintain, to respect the rights of the port maintainer you should follow
     322      the following guidelines:</para>
    319323
    320324      <orderedlist>
     325        <listitem>
     326          <para>If a port's maintainer is
     327          <email>nomaintainer@macports.org</email>, you may feel free to make
     328          updates and/or take maintainership of the port.</para>
     329        </listitem>
     330
     331        <listitem>
     332          <para>If a port's maintainer contains the address
     333          <email>openmaintainer@macports.org</email>: this signals that the
     334          author allows updates to the port without contacting him first. But
     335          permission should still be sought for major changes.</para>
     336        </listitem>
     337
    321338        <listitem>
    322339          <para>Create patch file(s) as necessary, attach them to a Trac
     
    326343
    327344        <listitem>
    328           <para>Wait for a response from the maintainer. The maintainer may
    329           apply the patches and close the ticket.</para>
    330         </listitem>
    331 
     345          <para>Wait for a response from the maintainer. The maintainer should
     346          apply the patches and close the ticket within 72 hours.</para>
     347        </listitem>
     348      </orderedlist>
     349
     350      <para>However, for maintained ports without
     351      <email>openmaintainer@macports.org</email>, there are some conditions
     352      under which maintainer permission may be waived:</para>
     353
     354      <itemizedlist>
    332355        <listitem>
    333356          <para>If the maintainer does not respond within 72 hours, you or
     
    337360          updates be committed.</para>
    338361        </listitem>
    339       </orderedlist>
    340 
    341       <para>There are circumstances for which the protocol may be
    342       waived:</para>
    343 
    344       <itemizedlist>
    345         <listitem>
    346           <para>A port's maintainer is
    347           <email>nomaintainer@macports.org</email>: feel free to make updates
    348           and/or take maintainership of these ports.</para>
    349         </listitem>
    350 
    351         <listitem>
    352           <para>A port's maintainer contains the address
    353           <email>openmaintainer@macports.org</email>: these ports are
    354           maintained, but the author allows updates to the port without
    355           contacting him first. But permission should still be sought for
    356           major changes.</para>
    357         </listitem>
    358362
    359363        <listitem>
     
    423427      </listitem>
    424428    </itemizedlist>
     429
    425430    <para>To apply for MacPorts commit rights, send a brief email to
    426     <email>macports-mgr@lists.macosforge.org</email> entitled &ldquo;Request
    427     for commit rights&rdquo; detailing the reasons for your application and why
    428     you think you deserve commit rights (including evidence of contributions to
     431    <email>macports-mgr@lists.macosforge.org</email> entitled “Request for
     432    commit rights” detailing the reasons for your application and why you
     433    think you deserve commit rights (including evidence of contributions to
    429434    MacPorts as described above).</para>
    430435  </section>
Note: See TracChangeset for help on using the changeset viewer.