Changeset 2622 for trunk/doc


Ignore:
Timestamp:
May 15, 2003, 1:55:50 PM (16 years ago)
Author:
michaelm
Message:

added bugreport bit and some more ids

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/user.xml

    r2621 r2622  
    193193                <para>There are a number of common problems so before you report a problem (details on how to <link linkend='user_bugs'>report problems</link> follow) check that the problem is described here, or in the <ulink url='http://www.opendarwin.org/projects/darwinports/en/faq.php'>FAQ</ulink> first.
    194194                </para>
    195                
    196                 <sect2 id='E_port_search'>
    197                         <title>port search failed: expected integer but got "PortIndex"</title>
    198 
    199                         <para>This means your PortIndex file is incorrect or potentially corrupted, run the <link linkend='portindex'>portindex</link> command
    200                         </para>
    201                        
     195                <sect2>
     196                        <title>Common Errors and Problems</title>
     197                                       
     198                        <sect3 id='E_port_search'>
     199                                <title>port search failed: expected integer but got "PortIndex"</title>
     200       
     201                                <para>This means your PortIndex file is incorrect or potentially corrupted, run the <link linkend='portindex'>portindex</link> command
     202                                </para>
     203                               
     204                        </sect3>
     205                </sect2>
     206               
     207                <sect2 id='user_bugs'>
     208                        <title>Bug Reports</title>
     209                        <para>If the you have updated your ports tree, searched the darwinports@opendarwin.org mailling list archives and read the common problems and the FAQ and you still can't find the answer to the problem, you should submit a bug report via bugzilla.
     210                        </para>
     211
     212                        <para>The following section describes in some more detail how to use Bugzilla to submit your port.</para>
     213
     214                        <sect3>
     215                                <title>Submission Parameters</title>
     216                               
     217                                <variablelist>
     218                                        <varlistentry id='Project'>
     219                                                <term>
     220                                                        Project:
     221                                                </term>
     222                                                <listitem>
     223                                                        <para>Make sure you select the Darwinports project.
     224                                                        </para>
     225                                                </listitem>
     226                                        </varlistentry>
     227
     228                                        <varlistentry id='Component'>
     229                                                <term>
     230                                                        Component:
     231                                                </term>
     232                                                <listitem>
     233                                                        <para>Select "dports" as the component.
     234                                                        </para>
     235                                                </listitem>
     236                                        </varlistentry>
     237                                        <varlistentry id='Assigned_to'>
     238                                                <term>
     239                                                        Assigned to:
     240                                                </term>
     241                                                <listitem>
     242                                                        <para>Please assign updates, bug reports and comments on existing ports to the maintainer. Otherwise, if this is a new port or an RFC, please leave blank
     243                                                        </para>
     244                                                </listitem>
     245                                        </varlistentry>
     246
     247                                        <varlistentry id='URL'>
     248                                                <term>
     249                                                        URL:
     250                                                </term>
     251                                                <listitem>
     252                                                        <para>You may use this field to point to the port output if it is available online.
     253                                                        </para>
     254                                                </listitem>
     255                                        </varlistentry>
     256
     257                                        <varlistentry id='Summary'>
     258                                                <term>
     259                                                        Summary:
     260                                                </term>
     261                                                <listitem>
     262                                                <para>Please use this format <userinput>BUG: portname-1.2.3</userinput> for the submission of port installation failures.
     263                                                </para>
     264                                                </listitem>     
     265                                        </varlistentry>
     266
     267                                        <varlistentry id='Description'>
     268                                                <term>
     269                                                        Description:
     270                                                </term>
     271                                                <listitem>
     272                                                        <para>The description field should contain the following information as per the example given here here.
     273                                                        </para>
     274                                                                <programlisting>
     275<![CDATA[
     276Portname-1.2.3
     277
     278the error log can be found here: URL or ATTACHED or INLINE
     279
     280Description: What the problem was in a nutshell,
     281
     282Comments: Any comments you have about the port, bug diagnosis steps,concerns, lookouts, dependencies that you may want to mention.
     283
     284================INLINE CONTENT================
     285--
     286your sig if you'd like
     287]]>
     288                                                </programlisting>
     289                                                               
     290                                                </listitem>
     291                                        </varlistentry>
     292                                </variablelist>
     293                        </sect3>
    202294                </sect2>
    203295        </sect1>
Note: See TracChangeset for help on using the changeset viewer.