aboutsummaryrefslogtreecommitdiff
path: root/en_US.ISO8859-1/articles/problem-reports
diff options
context:
space:
mode:
authorMark Linimon <linimon@FreeBSD.org>2019-06-14 09:22:49 +0000
committerMark Linimon <linimon@FreeBSD.org>2019-06-14 09:22:49 +0000
commit31000fe0848d92c3833be99a752dfeb83ccc564a (patch)
tree7a5e047bd9793af03f37dc2dc2755ca343ec7ea1 /en_US.ISO8859-1/articles/problem-reports
parent6d06632c280b9a623bff0ff6a9ea05cd473b11bb (diff)
downloaddoc-31000fe0848d92c3833be99a752dfeb83ccc564a.tar.gz
doc-31000fe0848d92c3833be99a752dfeb83ccc564a.zip
Remove text about including text such as [patch] or [maintainer update]
in the Synopsis. This has been bad advice for a number of years. The Keywords field has supplanted this. This article is still very, very, stale and needs more work. Reported by: koobs
Notes
Notes: svn path=/head/; revision=53147
Diffstat (limited to 'en_US.ISO8859-1/articles/problem-reports')
-rw-r--r--en_US.ISO8859-1/articles/problem-reports/article.xml18
1 files changed, 3 insertions, 15 deletions
diff --git a/en_US.ISO8859-1/articles/problem-reports/article.xml b/en_US.ISO8859-1/articles/problem-reports/article.xml
index f7e4b77c5f..fc038f0ebe 100644
--- a/en_US.ISO8859-1/articles/problem-reports/article.xml
+++ b/en_US.ISO8859-1/articles/problem-reports/article.xml
@@ -328,19 +328,14 @@
<listitem>
<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> (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>
+ looked at than one without. Please set the
+ <literal>patch</literal> Keyword in Bugzilla.</para>
</listitem>
<listitem>
<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> (including the
- brackets) at the beginning of your synopsis line, and you
+ instance, an existing port), you
definitely should set the <quote>Class</quote> of your PR
to <literal>maintainer-update</literal>. This way any
committer that handles your PR will not have to
@@ -611,13 +606,6 @@
email, and is used in problem report listings and
summaries; problem reports with obscure synopses tend to
get ignored.</para>
-
- <para>As noted above, if your problem report includes a
- patch, 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>
- (including the brackets).</para>
</listitem>
<listitem>