aboutsummaryrefslogtreecommitdiff
path: root/documentation/content/en/articles
diff options
context:
space:
mode:
authorMark Johnston <markj@FreeBSD.org>2025-09-05 15:18:59 +0000
committerMark Johnston <markj@FreeBSD.org>2025-09-09 22:57:03 +0000
commita67a08fd5803888c6ad4115ec88e98febbe4d9dd (patch)
tree84e1a1a6a8d3c1f00fefd5b1a9a2ab39684142c7 /documentation/content/en/articles
parent42cc566cd20ab5ec520d52cb02e50226e524acd2 (diff)
Diffstat (limited to 'documentation/content/en/articles')
-rw-r--r--documentation/content/en/articles/committers-guide/_index.adoc6
1 files changed, 5 insertions, 1 deletions
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.