Date: Fri, 14 Jun 2019 09:22:49 +0000 (UTC) From: Mark Linimon <linimon@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r53147 - head/en_US.ISO8859-1/articles/problem-reports Message-ID: <201906140922.x5E9MnTX046586@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: linimon Date: Fri Jun 14 09:22:49 2019 New Revision: 53147 URL: https://svnweb.freebsd.org/changeset/doc/53147 Log: 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 Modified: head/en_US.ISO8859-1/articles/problem-reports/article.xml Modified: head/en_US.ISO8859-1/articles/problem-reports/article.xml ============================================================================== --- head/en_US.ISO8859-1/articles/problem-reports/article.xml Fri Jun 14 00:38:53 2019 (r53146) +++ head/en_US.ISO8859-1/articles/problem-reports/article.xml Fri Jun 14 09:22:49 2019 (r53147) @@ -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>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201906140922.x5E9MnTX046586>