From owner-svn-doc-all@freebsd.org Fri Jun 14 09:22:50 2019 Return-Path: Delivered-To: svn-doc-all@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 9098C15CB7F3; Fri, 14 Jun 2019 09:22:50 +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 EF7708AF8A; Fri, 14 Jun 2019 09:22:49 +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 C3B25DE36; Fri, 14 Jun 2019 09:22:49 +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 x5E9MngB046587; Fri, 14 Jun 2019 09:22:49 GMT (envelope-from linimon@FreeBSD.org) Received: (from linimon@localhost) by repo.freebsd.org (8.15.2/8.15.2/Submit) id x5E9MnTX046586; Fri, 14 Jun 2019 09:22:49 GMT (envelope-from linimon@FreeBSD.org) Message-Id: <201906140922.x5E9MnTX046586@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:22:49 +0000 (UTC) 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 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: 53147 X-SVN-Commit-Repository: doc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-Rspamd-Queue-Id: EF7708AF8A 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_SHORT(-0.98)[-0.982,0]; NEURAL_HAM_LONG(-1.00)[-1.000,0]; ASN(0.00)[asn:11403, ipnet:2610:1c1:1::/48, country:US] X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 14 Jun 2019 09:22:50 -0000 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 @@ If you have a patch, say so. 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 [patch] (including the - brackets) at the beginning of the Synopsis. - (Although it is not mandatory to use that exact string, by - convention, that is the one that is used.) + looked at than one without. Please set the + patch Keyword in Bugzilla. If you are a maintainer, say so. If you are maintaining a part of the source code (for - instance, a port), you might consider adding the string - [maintainer update] (including the - brackets) at the beginning of your synopsis line, and you + instance, an existing port), you definitely should set the Class of your PR to maintainer-update. 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. - - As noted above, if your problem report includes a - patch, please have the synopsis start with - [patch] (including the brackets); if - this is a ports PR and you are the maintainer, you may - consider adding [maintainer update] - (including the brackets).