os/doc
3
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

Clarify that we need to use the brackets, and update the web page references

Browse source 
with actual links. [1]

Also s/submittal/submission/ (changed by myself)

PR:			123043 [1]
Submitted by:		Lawrence Mayer <lawmay3 at i12 dot com> [1]
This commit is contained in:
Remko Lodder 2008-07-13 14:04:34 +00:00
parent e679c2393b
commit bccf5d092b
Notes: svn2git 2020-12-08 03:00:23 +00:00 
svn path=/head/; revision=32522
1 changed files with 10 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
en_US.ISO8859-1/articles/problem-reports/article.sgml
View file

@ -342,7 +342,7 @@
<para><emphasis>If you have a patch, say so.</emphasis>
A PR with a patch included is much more likely to be
looked at than one without. If you are including one,
put the string <literal>[patch]</literal> at the
put the string <literal>[patch]</literal> (including the brackets) at the
beginning of the <quote>Synopsis</quote>. (Although it is
not mandatory to use that exact string, by convention,
that is the one that is used.)</para>
@ -352,7 +352,7 @@
<para><emphasis>If you are a maintainer, say so.</emphasis>
If you are maintaining a part of the source code (for
instance, a port), you might consider adding the string
<literal>[maintainer update]</literal> at the beginning of
<literal>[maintainer update]</literal> (including the brackets) at the beginning of
your synopsis line, and you definitely should set the
<quote>Class</quote> of
your PR to <literal>maintainer-update</literal>. This way
@ -521,8 +521,9 @@
you insert manual linebreaks somewhere around 70 characters,
so that the web display of the PR will be readable.</para>
<para>Similar considerations apply if you are using the web-based
PR submittal form instead of &man.send-pr.1;. Note that
<para>Similar considerations apply if you are using the
<ulink url="http://www.freebsd.org/send-pr.html"> web-based
PR submission form</ulink> instead of &man.send-pr.1;. Note that
cut-and-paste operations can have their own side-effects on
text formatting. In certain cases it may be necessary to use
&man.uuencode.1; to ensure that patches arrive unmodified.</para>
@ -530,7 +531,7 @@
<para>Finally, if your submission will be lengthy, you should
to prepare your work offline so that nothing will be lost in
case there is a problem submitting it. This can be an especial
problem with the web form.</para>
problem with the<ulink url="http://www.freebsd.org/send-pr.html"> web form</ulink>.</para>
</section>
<section>
@ -638,7 +639,7 @@
</itemizedlist>
<para>The next section describes fields that are common to both
the email interface and the web interface:</para>
the email interface and the<ulink url="http://www.freebsd.org/send-pr.html"> web interface</ulink>:</para>
<itemizedlist>
@ -677,10 +678,10 @@
get ignored.</para>
<para>As noted above, if your problem report includes a patch,
please have the synopsis start with <literal>[patch]</literal>;
please have the synopsis start with <literal>[patch]</literal> (including the brackets);
if this is a ports PR and you are the
maintainer, you may consider adding
<literal>[maintainer update]</literal> and set the
<literal>[maintainer update]</literal> (including the brackets) and set the
<quote>Class</quote> of your PR to
<literal>maintainer-update</literal>.</para>
</listitem>
@ -1107,7 +1108,7 @@
<para>This will read the specified file, validate the contents,
strip comments and send it off.</para>
<para>If you are using the web form:</para>
<para>If you are using the<ulink url="http://www.freebsd.org/send-pr.html"> web form</ulink>:</para>
<para>Before you hit <literal>submit</literal>, you will need to
fill in a field containing text that is represented in image