From nobody Tue Sep 9 22:58:29 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 4cLzks4RPkz66ZTF for ; Tue, 09 Sep 2025 22:58:29 +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 "R12" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4cLzks3wDwz3Tvt; Tue, 09 Sep 2025 22:58:29 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1757458709; 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=S2t/bE0siEO3MhfibaF1PYRayj91npBNmcA7I/VIpKI=; b=PsmL7pPsTP6/IrgOvbPbI6APG8ZeAwa8q9HW3MF/nmKmUERKJYbgJD5wcmlDfKSX6rC7Jj pL3tOu5kSJ6Daka05nGTbCi6lUW7gzCxRxmnmzzmwtrmCHAZo0xZjYSr7T7ohCqUN91QIy iXDtW4cgsVEDpiITLogL7dVCCwEzBj+opzornMsLNM9FYjNzghFJH8wH11SWfkEy8xVDiI OQ3GyAgt0w8Cb82xGWVvCdqD6rq0A1nm0T2SjUfl9s9/wyuwmULQRjCcYUZk/IvI3nC8VC R+9IdqUSE8xdK+qhAqppQMgEDcLtBS2VFGbodUFHHfs1xUsmsd8/HzN5e3QJ/g== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1757458709; 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=S2t/bE0siEO3MhfibaF1PYRayj91npBNmcA7I/VIpKI=; b=l0rYZ+YAwxl0NfdR9YBJkNSnauvftt3mvKOTjG1w1qEDpx1QcWZNbA4TUQZxfQ2uLer92N tGa3wXo5zh93nlyGHSDCAPAv/u/2/YOrG9cq0XxTFGAKIC/RHZCgXjL2VgJhUJH3VWb5LP CjAJGVtTfdlkbo+TM6xbrHc2okEkHQNh2Xe5lcAQE4Daz1ALLIBh5nv2M1Ss5t/qFInhsN +OEuYe1kGgb2434ZgqYsdJSjCUj6dUouAlTQtu370yH6+g7Lw515zjz4NdxrmbTqioTVgv jVi3v5PsMJqQOOSR3R1huYhcYsPafrgrC0opd0q9gNexEWtZrYJNfN9qhiOZHQ== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1757458709; a=rsa-sha256; cv=none; b=CAIQhtMYy6LLzPLzN8HXj8gj/k8HKhJR4q9cRRQk1/CzBl41nxKWZBsCiGDxOivIviu5Vo 324duIzpH1Eg+meJH/xy/bWqz232jri5A9px1GwHCSrhAbjl/+QpiasgR1Xnl+aifYfCqy M/7LQCjiGtWV4IkJeND/Jt4R3eeii50DDDFFT5T/V0NfGBGEwEAjjmd8Wu39zmQZ554Y2L Kenv2xzBKIHSLQbN8s0sGUCGO4HTV8qVPMZo6Wb/qHP3DpPQQ7RdmYj+k2oATBCFISR+yT YSO9pWAz+5E78uox68fDNybYcHW45u/uiQyUlukWw1nlcE15sJgCcwy9qRD5QQ== ARC-Authentication-Results: i=1; mx1.freebsd.org; none 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 4cLzks30M2zwS3; Tue, 09 Sep 2025 22:58:29 +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 589MwTqP031217; Tue, 9 Sep 2025 22:58:29 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 589MwTDp031214; Tue, 9 Sep 2025 22:58:29 GMT (envelope-from git) Date: Tue, 9 Sep 2025 22:58:29 GMT Message-Id: <202509092258.589MwTDp031214@gitrepo.freebsd.org> To: doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org From: Mark Johnston Subject: git: a67a08fd58 - main - committers-guide: Mention RELNOTES in a couple of places 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: markj X-Git-Repository: doc X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: a67a08fd5803888c6ad4115ec88e98febbe4d9dd Auto-Submitted: auto-generated The branch main has been updated by markj: URL: https://cgit.FreeBSD.org/doc/commit/?id=a67a08fd5803888c6ad4115ec88e98febbe4d9dd commit a67a08fd5803888c6ad4115ec88e98febbe4d9dd Author: Mark Johnston AuthorDate: 2025-09-05 15:18:59 +0000 Commit: Mark Johnston CommitDate: 2025-09-09 22:57:03 +0000 committers-guide: Mention RELNOTES in a couple of places Reviewed by: imp, olce, emaste Differential Revision: https://reviews.freebsd.org/D52396 --- documentation/content/en/articles/committers-guide/_index.adoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/documentation/content/en/articles/committers-guide/_index.adoc b/documentation/content/en/articles/committers-guide/_index.adoc index 2650a480ba..26bb41e98b 100644 --- a/documentation/content/en/articles/committers-guide/_index.adoc +++ b/documentation/content/en/articles/committers-guide/_index.adoc @@ -1395,7 +1395,7 @@ Here 'good' means: . All the right files, and none of the wrong ones, were merged into contrib/glorbnitz. . No other changes are in the tree. . The commit messages look crossref:committers-guide[commit-log-message,good]. It should contain a summary of what's changed since the last merge to the FreeBSD `main` branch and any caveats. -. UPDATING should be updated if there is anything of note, such as user visible changes, important upgrade concerns, etc. +. `RELNOTES` and `UPDATING` should be updated if there is anything of note, such as user visible changes, important upgrade concerns, etc. [NOTE] ==== @@ -2653,6 +2653,10 @@ We include the commit title so that the referenced commit can be located even in |`Relnotes:` |If the change is a candidate for inclusion in the release notes for the next release from the branch, set to `yes`. +|Candidates are user-visible changes, new features, compatibility breaks, etc.. +|If you forget to set this line, or want to provide more details, add an entry to the `RELNOTES` file in the root of the src tree. +|The `RELNOTES` file is used to generate release notes for the next release. +|Do not use the `Relnotes:` line to describe the change: its only valid value is `yes`. |`Security:` |If the change is related to a security vulnerability or security exposure, include one or more references or a description of the issue. If possible, include a VuXML URL or a CVE ID.