Date: Fri, 14 Jun 2019 09:29:28 +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: r53149 - head/en_US.ISO8859-1/articles/problem-reports Message-ID: <201906140929.x5E9TSm3046743@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: linimon Date: Fri Jun 14 09:29:27 2019 New Revision: 53149 URL: https://svnweb.freebsd.org/changeset/doc/53149 Log: s/Synopsis/Summary/g Synopsis was GNATS-specific. 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 09:26:55 2019 (r53148) +++ head/en_US.ISO8859-1/articles/problem-reports/article.xml Fri Jun 14 09:29:27 2019 (r53149) @@ -299,7 +299,7 @@ <para><emphasis>Do not leave the <quote>Summary</quote> line empty.</emphasis> The PRs go both onto a mailing list that goes all over the world (where the - <quote>Synopsis</quote> is used for the + <quote>Summary</quote> is used for the <literal>Subject:</literal> line), but also into a database. Anyone who comes along later and browses the database by synopsis, and finds a PR with a blank subject @@ -310,19 +310,19 @@ </listitem> <listitem> - <para><emphasis>Avoid using a weak <quote>Synopsis</quote> + <para><emphasis>Avoid using a weak <quote>Summary</quote> line.</emphasis> You should not assume that anyone reading your PR has any context for your submission, so the more you provide, the better. For instance, what part of the system does the problem apply to? Do you only see the problem while installing, or while running? To illustrate, instead of - <literal>Synopsis: portupgrade is broken</literal>, see + <literal>Summary: portupgrade is broken</literal>, see how much more informative this seems: - <literal>Synopsis: port ports-mgmt/portupgrade coredumps + <literal>Summary: port ports-mgmt/portupgrade coredumps on -current</literal>. (In the case of ports, it is especially helpful to have both the category and portname - in the <quote>Synopsis</quote> line.)</para> + in the <quote>Summary</quote> line.)</para> </listitem> <listitem>
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201906140929.x5E9TSm3046743>