From nobody Fri Mar 21 17:02:45 2025 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 4ZK7zp1kTdz5rRnW for ; Fri, 21 Mar 2025 17:02:46 +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 "R10" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4ZK7zn6lh6z3LhC; Fri, 21 Mar 2025 17:02:45 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1742576566; 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=8/4kmSjr4EgZDVTBH1voSTWEaF+35N+LO/vMheH9gaU=; b=AhRF9Lf5lD4vOlBCjJFcfsx5DchqJd2FpSHA3osFasO/rcNnIrdZGJUUZgWm+rRcvquuGU Km7VdOMeCmXzVHjziUKieLdm7zxRTXGuS5AGcl16kkIc4kBxSXqnHmGw9coSv+W6+akVq5 X4vC+e96TwOiaesDrG1neLUzZkbbz1fkOVR55PIEs41vMX0wP42k6X+lbvV0Fr4tM2ju0y bk9S5N3AhDCJQge+r87deHzR24Epd0R8XehgWSbqB47F1ud5XvAY/TGNsPdSmiVIAHO2oK wTXXNlLga6gUjSPaVyMZJNU7LbjZNW1cRJqKuT4KMkLevQqVMhBD693KoWlDVQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1742576566; a=rsa-sha256; cv=none; b=UWsuM8M30601vi/P7M/Zt0qKpVRntzbWquSalmb9SqwZ2L8w89qO0AZ1/WqFJhXqB8CsEy JFb3wYqJJh77nut6f7jc+d/iS/jiW9trmr/l2YNcYw4VbD+toWknmK97qRahLXRXh618Mq 01tzMjuLTmpTO2jW/Z3ZWwkQZBoRKkOGlJXA80mC9ZldQhIf2H3KD/V2xs8Oq9f+BiS/2X MKKXyOAJWzi5VwAaYj9v1IeTnB0K9X56nQJFV0FRNdhIWX0Mk5AmA/qMyHaBooWG2Z6/yj W2TpY+8Nlup0jr/5sIWC2FzHcyg88O/isJSFEExldJvKZCa4VK1qERF54uJ4yw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1742576566; 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=8/4kmSjr4EgZDVTBH1voSTWEaF+35N+LO/vMheH9gaU=; b=WgcEiHuBEFAdHOgsbjgR4921YyxTmdmTgMVpDc8BvtSxItY6JPlQC9Z6W6tvt6AaqYt2gM KTlf0YRygLBoMNXsg628xOOBwwvWgYEzMBG9rMVFeazM+mkY/SgoiSht7ah98rXfZfQdrs JGHVr2dYaDwY99a8t5U97G9esael2LDkYJo0SfPQVl9aLGMv5tjqA8GLRvGDS2MF0sRJVN oHcHne84Ygyrj/hVEJuZcJCA4zdrBFv5zphatc7jikCnrdxWxylRlCoUA2gE0dOYU0C0JP R8orhfhN3eRAPa5MmxxIrBvTRRrcGTvyP0sr12Z6ipfxJ30eR1KZk76yaQUhmA== 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 4ZK7zn4sF5zl2Y; Fri, 21 Mar 2025 17:02:45 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 52LH2jtI038679; Fri, 21 Mar 2025 17:02:45 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 52LH2jMT038676; Fri, 21 Mar 2025 17:02:45 GMT (envelope-from git) Date: Fri, 21 Mar 2025 17:02:45 GMT Message-Id: <202503211702.52LH2jMT038676@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Brooks Davis Subject: git: 4ccefaf81a - main - committers guide: permit key words more than once 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: X-BeenThere: dev-commits-doc-all@freebsd.org Sender: owner-dev-commits-doc-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: brooks X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 4ccefaf81a2eea34ac0286a49bc3ae5e4008dcb5 Auto-Submitted: auto-generated The branch main has been updated by brooks: URL: https://cgit.FreeBSD.org/doc/commit/?id=4ccefaf81a2eea34ac0286a49bc3ae5e4008dcb5 commit 4ccefaf81a2eea34ac0286a49bc3ae5e4008dcb5 Author: Brooks Davis AuthorDate: 2025-03-21 17:02:39 +0000 Commit: Brooks Davis CommitDate: 2025-03-21 17:02:39 +0000 committers guide: permit key words more than once While some key words such as "MFC after:" should only appear once, others such as "PR:" or "Sponsored by:" may be clearer if each entry appears on it's own line. This is already somewhat common practice so explicitly permit it. Reviewed by: kevans, imp, emaste Differential Revision: https://reviews.freebsd.org/D49429 --- documentation/content/en/articles/committers-guide/_index.adoc | 2 ++ 1 file changed, 2 insertions(+) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 2cdb75630b..91c14a89c1 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -2542,6 +2542,8 @@ As well as including an informative message with each commit, some additional in This information consists of one or more lines containing the key word or phrase, a colon, tabs for formatting, and then the additional information. +For key words where multiple values make sense (e.g., `PR:` with a comma-separated list of PRs), it is permitted to use the same keyword multiple times to avoid ambiguity or improve readability. + The key words or phrases are: [.informaltable]