Changeset 50255 for trunk/doc-new


Ignore:
Timestamp:
Apr 28, 2009, 9:34:54 AM (10 years ago)
Author:
jmr@…
Message:

Update guide to reflect Trac changes.

File:
1 edited

Legend:

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

    r47536 r50255  
    112112          be relevant to someone reading the ticket. <ulink
    113113          url="http://trac.macports.org/wiki/WikiFormatting">Wiki
    114           formatting</ulink> or attached log files should be used for large
    115           text blocks. If you want to post a build log make sure you use
    116           <literal>{{{<replaceable>...</replaceable>}}}</literal> around the
    117           log or it could break the page layout. Example:</para>
     114          formatting</ulink> should be used to ensure that text is formatted
     115          correctly. Use the Preview button before submitting. If you want to
     116          post preformatted text such as a log or terminal output, make sure
     117          you use <literal>{{{<replaceable>...</replaceable>}}}</literal>
     118          around the text or it could break the page layout. Example:</para>
    118119
    119120          <literallayout>
     
    123124          </literallayout>
    124125
    125           <para>Submitters are advised to trim pastes and logs of any kind to what's
    126           really relevant to the report, as otherwise overly large submissions that
    127           might contain redundant and/or unnecessary information might become unmanageable.
     126          <para>Submitters are advised to trim pastes and logs of any kind to
     127          what's really relevant to the report, as otherwise overly large
     128          submissions that might contain redundant and/or unnecessary
     129          information might become unmanageable. If it is truly necessary to
     130          include long output, use an attachment, don't paste it inline.
    128131          </para>
    129132
     
    131134
    132135        <listitem>
    133           <para><guilabel>Type:</guilabel> There are two main types of
     136          <para><guilabel>Type:</guilabel> There are five types of
    134137          tickets.</para>
    135138
     
    145148              intended purpose.</para>
    146149            </listitem>
     150           
     151            <listitem>
     152              <para><guimenu>update</guimenu> - Tickets, with or without
     153              patches, involving updating a port to a newer upstream
     154              version.</para>
     155            </listitem>
     156           
     157            <listitem>
     158              <para><guimenu>submission</guimenu> - Tickets created to submit
     159              Portfiles for software not currently available in MacPorts.
     160              </para>
     161            </listitem>
     162           
     163            <listitem>
     164              <para><guimenu>request</guimenu> - Tickets created to request
     165              the creation of a new port.</para>
     166            </listitem>
    147167          </itemizedlist>
    148168        </listitem>
     
    178198
    179199        <listitem>
    180           <para><guilabel>Milestone:</guilabel> This is a ticket category that
    181           allows for search and sorting tickets efficiently.</para>
    182 
    183           <itemizedlist>
    184             <listitem>
    185               <para><guimenu>MacPorts x.y.z</guimenu> - for base-level
    186               tickets which have been assigned to a particular future
    187               release of MacPorts.</para>
    188             </listitem>
    189 
    190             <listitem>
    191               <para><guimenu>MacPorts Future</guimenu> - for base-level
    192               tickets which are still under consideration and have not
    193               yet been assigned to a specific future release of
    194               MacPorts.</para>
    195             </listitem>
    196 
    197             <listitem>
    198               <para><guimenu>Port Bugs</guimenu> - for tickets reporting or
    199               fixing bugs in ports provided by MacPorts.</para>
    200             </listitem>
    201 
    202             <listitem>
    203               <para><guimenu>Port Enhancements</guimenu> - for submissions
    204               providing enhancements to ports provided by MacPorts.</para>
    205             </listitem>
    206 
    207             <listitem>
    208               <para><guimenu>Port Requests</guimenu> - for requests for ports
    209               to be added to MacPorts.</para>
    210             </listitem>
    211 
    212             <listitem>
    213               <para><guimenu>Port Submissions</guimenu> - for submissions that
    214               add a port to MacPorts.</para>
    215             </listitem>
    216 
    217             <listitem>
    218               <para><guimenu>Port Updates</guimenu> - for submissions that
    219               update a port provided by MacPorts.</para>
    220             </listitem>
    221 
    222             <listitem>
    223               <para><guimenu>Website &amp; Documentation</guimenu> - for
    224               tickets relating to the documentation for MacPorts, including
    225               the MacPorts guide, Wiki, man pages and the website.</para>
    226             </listitem>
    227 
    228             <listitem>
    229               <para>Blank - For unclassified tickets that don't fit into any
    230               of the provided milestones.</para>
    231             </listitem>
    232           </itemizedlist>
     200          <para><guilabel>Milestone:</guilabel> This is a ticket label that
     201          indicates that the ticket is intended to be fixed in a particular
     202          MacPorts release. Leave it blank; it will be set by a project member
     203          if appropriate.</para>
    233204        </listitem>
    234205
     
    287258          development of the ticket. Multiple email addresses should be
    288259          separated with a comma and a space
    289           (i.e. <literal>you@example.org, maintainer@macports.org</literal>).
    290           If you do not see the the <guilabel>Assign to:</guilabel> field
    291           (currently only committers can set <guilabel>Assign to:</guilabel>),
    292           add the email address of the port's maintainer(s) here; you can use
    293           <command>port info <replaceable>portname</replaceable></command>
    294           to find the maintainer for a port.  Exclude the addresses
    295           <email>openmaintainer@macports.org</email> and
    296           <email>nomaintainer@macports.org</email> if they are listed.</para>
     260          (i.e. <literal>you@example.org, maintainer@macports.org</literal>).</para>
     261         
     262          <para>Most users will not be able to assign tickets. If this applies
     263          to you, then when reporting port-related tickets, make sure you add
     264          the port's maintainer to cc. Otherwise they may not notice the
     265          ticket.</para>
     266        </listitem>
     267       
     268        <listitem>
     269          <para><guilabel>Assign To:</guilabel> Only users with commit access
     270          can edit this field. If this is not you, see the section on the
     271          <guimenu>Cc</guimenu> field above.</para>
     272         
     273          <para>For tickets on ports, enter
     274          the email address of the port's maintainer (use <command>port info
     275          &lt;portname&gt;</command> to find this). If multiple maintainers
     276          are listed, enter the first maintainer's email address here and
     277          enter the remainining maintainers' email addresses in the
     278          <guimenu>Cc</guimenu> field. Exclude the email address
     279          <email>openmaintainer@macports.org</email> if it appears.
     280          If the maintainer's email address is
     281          <email>nomaintainer@macports.org</email>, leave the field
     282          blank.</para>
    297283        </listitem>
    298284
     
    334320
    335321        <listitem>
    336           <para>Set the type to <guilabel>enhancement</guilabel>.</para>
    337         </listitem>
    338 
    339         <listitem>
    340           <para>Set the milestone to <guilabel>Port
    341           Submissions</guilabel>.</para>
     322          <para>Set the type to <guilabel>submission</guilabel>.</para>
     323        </listitem>
     324
     325        <listitem>
     326          <para>Set the component to <guilabel>ports</guilabel>.</para>
    342327        </listitem>
    343328
     
    370355        <listitem>
    371356          <para>Set the type to <guilabel>enhancement</guilabel> for
    372           miscellaneous enhancements or to <guilabel>defect</guilabel> for bug
    373           fixes.</para>
    374         </listitem>
    375 
    376         <listitem>
    377           <para>Set the milestone to <guilabel>Port Enhancements</guilabel>,
    378           <guilabel>Port Updates</guilabel> or <guilabel>Port Bugs</guilabel>
    379           depending on the case.</para>
     357          miscellaneous enhancements, to <guilabel>defect</guilabel> for bug
     358          fixes, or to <guilabel>update</guilabel> for version updates.</para>
     359        </listitem>
     360
     361        <listitem>
     362          <para>Set the component to <guilabel>ports</guilabel>.</para>
    380363        </listitem>
    381364
Note: See TracChangeset for help on using the changeset viewer.