Date: Fri, 21 Mar 2025 17:02:45 GMT From: Brooks Davis <brooks@FreeBSD.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org Subject: git: 4ccefaf81a - main - committers guide: permit key words more than once Message-ID: <202503211702.52LH2jMT038676@gitrepo.freebsd.org>
next in thread | raw e-mail | index | archive | help
The branch main has been updated by brooks: URL: https://cgit.FreeBSD.org/doc/commit/?id=4ccefaf81a2eea34ac0286a49bc3ae5e4008dcb5 commit 4ccefaf81a2eea34ac0286a49bc3ae5e4008dcb5 Author: Brooks Davis <brooks@FreeBSD.org> AuthorDate: 2025-03-21 17:02:39 +0000 Commit: Brooks Davis <brooks@FreeBSD.org> 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]
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202503211702.52LH2jMT038676>