From owner-svn-doc-head@freebsd.org Fri Jun 14 09:29:29 2019 Return-Path: Delivered-To: svn-doc-head@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id EC54F15CB8BC; Fri, 14 Jun 2019 09:29:28 +0000 (UTC) (envelope-from linimon@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) server-signature RSA-PSS (4096 bits) client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 8D5F88B0AC; Fri, 14 Jun 2019 09:29:28 +0000 (UTC) (envelope-from linimon@FreeBSD.org) Received: from repo.freebsd.org (repo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 75BE8DE3B; Fri, 14 Jun 2019 09:29:28 +0000 (UTC) (envelope-from linimon@FreeBSD.org) Received: from repo.freebsd.org ([127.0.1.37]) by repo.freebsd.org (8.15.2/8.15.2) with ESMTP id x5E9TSqQ046744; Fri, 14 Jun 2019 09:29:28 GMT (envelope-from linimon@FreeBSD.org) Received: (from linimon@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x5E9TSm3046743; Fri, 14 Jun 2019 09:29:28 GMT (envelope-from linimon@FreeBSD.org) Message-Id: <201906140929.x5E9TSm3046743@repo.freebsd.org> X-Authentication-Warning: repo.freebsd.org: linimon set sender to linimon@FreeBSD.org using -f From: Mark Linimon Date: Fri, 14 Jun 2019 09:29:28 +0000 (UTC) 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 X-SVN-Group: doc-head X-SVN-Commit-Author: linimon X-SVN-Commit-Paths: head/en_US.ISO8859-1/articles/problem-reports X-SVN-Commit-Revision: 53149 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: 8D5F88B0AC X-Spamd-Bar: -- Authentication-Results: mx1.freebsd.org X-Spamd-Result: default: False [-2.98 / 15.00]; local_wl_from(0.00)[FreeBSD.org]; NEURAL_HAM_MEDIUM(-1.00)[-0.998,0]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; NEURAL_HAM_SHORT(-0.98)[-0.982,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US] X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 14 Jun 2019 09:29:29 -0000 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 @@ Do not leave the Summary line empty. The PRs go both onto a mailing list that goes all over the world (where the - Synopsis is used for the + Summary is used for the Subject: 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 @@ - Avoid using a weak Synopsis + Avoid using a weak Summary line. 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 - Synopsis: portupgrade is broken, see + Summary: portupgrade is broken, see how much more informative this seems: - Synopsis: port ports-mgmt/portupgrade coredumps + Summary: port ports-mgmt/portupgrade coredumps on -current. (In the case of ports, it is especially helpful to have both the category and portname - in the Synopsis line.) + in the Summary line.)