From nobody Sat Oct 29 03:31:25 2022 X-Original-To: dev-commits-doc-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4MzlM15S0Zz4glq8 for ; Sat, 29 Oct 2022 03:31:25 +0000 (UTC) (envelope-from git@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) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4MzlM14wv4z3ppl; Sat, 29 Oct 2022 03:31:25 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667014285; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=7eKOzX4BQ31bLbGkSh/9ov28yO3Au+PwS5ckq8jzoY0=; b=qdqQa7EZkT7BOM9z/+WbHK7PjzaHLPnmkypD5GFSWXR/9YYyu9JaZaI74v2xFzM8vXeEmF iKYy9aozwbrcoJcQwFhw2Ht8Zai1VHHABZOiVTEXlnAhDMaSHWFyQk/Y6SyrypM1UKvQOi 2fzks782KgJPB0e5DjE86A9LYGOVCfUP3XhvyRNftnq2B7U4rhumaksgu2jcuECadRfpOf VNN/XITlECl8S1fdYdsILsmaZYIPi38gt/YT3mhUEVw3qo9yGK4PyfjipsjuB8EAq7LLEG gbnzhzIKZH/TE3dj16UFlZDbKJMouGL+uHNNe79i58r5bSpOa86y8KXY88kWcw== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4MzlM140Sxz12hb; Sat, 29 Oct 2022 03:31:25 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 29T3VPpV068929; Sat, 29 Oct 2022 03:31:25 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 29T3VPKb068928; Sat, 29 Oct 2022 03:31:25 GMT (envelope-from git) Date: Sat, 29 Oct 2022 03:31:25 GMT Message-Id: <202210290331.29T3VPKb068928@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Graham Perrin Subject: git: 03d204adfd - main - articles/problem-reports: cease recommending the 'patch' keyword List-Id: Commit messages for all branches of the doc repository List-Archive: https://lists.freebsd.org/archives/dev-commits-doc-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-doc-all@freebsd.org X-BeenThere: dev-commits-doc-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: grahamperrin X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 03d204adfdf1a7bb586db28e9e83e63ca683a3ad Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1667014285; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=7eKOzX4BQ31bLbGkSh/9ov28yO3Au+PwS5ckq8jzoY0=; b=wjbXly7nxExsPP17sW/80TeLsRNIw3kJ3ciY9r7Xz9d88mA9DtcKOXg4QCuqAqWqICHFdH 2+H3VxWXkqh/rh3mNPh2hiK3h4zFzaAG7a/gu0hei520KzByfHVEuGZRujZNPlBP1a54Kt 0s5lV/Ok0h8La4UW0OyKm2Si2fJGanFDr0BN9RFmrWJkxSEcW/8lxf+qlXOZvFNhvTqQNY iC8mXYDPvtF5w8NK/t3YvXFHDaOofNpT+jf24Wy0syQQmwe5pfKnmYhgG2K06Dfo8oh8p+ v7p45t8Gge+ZDpe+0bdnJc2cGRBqoFcKf8BUkq0ZnXImy+feyKK8EJ3HcJE+Ig== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1667014285; a=rsa-sha256; cv=none; b=eTMV0GNAt3gAppmncjx8D8I8Pe530WgzPnITl3OpqzK6bf9cCNux18B4531cxoFS9YeVYk LBiYH1JJwF1p+52+n2sRFpbOdFNWGCRQqPy+GqYQ570kmFkeFiFH06pi6pcafVnRj2Vs8D hNJrW+Mc+AOAsfo8VJy1t+tDRMWG1CANp1uabqshFdnoPfxNjjba/7/c3fQzkCMPs+auKW pKZUK2cOwd0ILL6VxOuelGDcZjG4Y04bD4q4rh/toDI4nkjcBxjaO85W6XUYQ7NFH51bA0 vpNtOjPvWFfiZIAFtD1O0xxujQZQt+aPGfNn8Ozv8m7aQcO+eY1bbgoiSXsGyA== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by grahamperrin: URL: https://cgit.FreeBSD.org/doc/commit/?id=03d204adfdf1a7bb586db28e9e83e63ca683a3ad commit 03d204adfdf1a7bb586db28e9e83e63ca683a3ad Author: Graham Perrin AuthorDate: 2022-10-29 03:16:34 +0000 Commit: Graham Perrin CommitDate: 2022-10-29 03:16:34 +0000 articles/problem-reports: cease recommending the 'patch' keyword 'Writing FreeBSD Problem Reports' pleads for use of a keyword: patch – https://docs.freebsd.org/en/articles/problem-reports/#pr-writing-tips Keywords 'patch' and 'patch-ready' remain in Bugzilla – https://bugs.freebsd.org/bugzilla/describekeywords.cgi – but should no longer be used. Both keywords are deprecated: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227147 Update the article: * end the plea * explain why the available keywords should not be used. PR: 267176 Bug report: https://bugs.freebsd.org/267176 Mentors: gjb, carlavilla Reviewed by: gjb Approved by: gjb Differential revision: https://reviews.freebsd.org/D37086 --- documentation/content/en/articles/problem-reports/_index.adoc | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/documentation/content/en/articles/problem-reports/_index.adoc b/documentation/content/en/articles/problem-reports/_index.adoc index 81cf7c92f9..fd0f5d343b 100644 --- a/documentation/content/en/articles/problem-reports/_index.adoc +++ b/documentation/content/en/articles/problem-reports/_index.adoc @@ -132,7 +132,9 @@ Before we get into the mechanics of the program used to generate and submit PRs, * _Do not leave the "Summary" line empty._ The PRs go both onto a mailing list that goes all over the world (where 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 line, tends just to skip over it. Remember that PRs stay in this database until they are closed by someone; an anonymous one will usually just disappear in the noise. * _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 `Summary: portupgrade is broken`, see how much more informative this seems: `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 "Summary" line.) -* _If you have a patch, say so._ A PR with a patch included is much more likely to be looked at than one without. Please set the `patch` Keyword in Bugzilla. +* _If you have a patch, say so._ +The presence of a patch makes it much easier to progress a report. +** Do not use the `patch` or `patch-ready` keywords – they are deprecated. * _If you are a maintainer, say so._ If you are maintaining a part of the source code (for 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 check. * _Be specific._ The more information you supply about what problem you are having, the better your chance of getting a response.