Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 10 Feb 2026 20:56:45 +0000
From:      Ed Maste <emaste@FreeBSD.org>
To:        doc-committers@FreeBSD.org, dev-commits-doc-all@FreeBSD.org
Cc:        Gordon Tetlow <gordon@FreeBSD.org>
Subject:   git: dbdc8dc646 - main - SA/EN templates: Add XX where replacements are needed
Message-ID:  <698b9b8d.3feb4.638dcca3@gitrepo.freebsd.org>

index | next in thread | raw e-mail

The branch main has been updated by emaste:

URL: https://cgit.FreeBSD.org/doc/commit/?id=dbdc8dc6460aea1c75d7455c977244fa0d96d79c

commit dbdc8dc6460aea1c75d7455c977244fa0d96d79c
Author:     Gordon Tetlow <gordon@FreeBSD.org>
AuthorDate: 2025-12-17 01:08:16 +0000
Commit:     Ed Maste <emaste@FreeBSD.org>
CommitDate: 2026-02-10 20:56:29 +0000

    SA/EN templates: Add XX where replacements are needed
---
 website/static/security/advisory-template.txt | 40 +++++++++++++--------------
 website/static/security/errata-template.txt   | 40 +++++++++++++--------------
 2 files changed, 40 insertions(+), 40 deletions(-)

diff --git a/website/static/security/advisory-template.txt b/website/static/security/advisory-template.txt
index 9de56d570f..2d4d33c07a 100644
--- a/website/static/security/advisory-template.txt
+++ b/website/static/security/advisory-template.txt
@@ -1,14 +1,14 @@
 =============================================================================
-FreeBSD-SA-ADVISORY_TEMPLATE                                Security Advisory
+FreeBSD-SA-XX_ADVISORY_TEMPLATE                             Security Advisory
                                                           The FreeBSD Project
 
-Topic:
+Topic:          XX
 
-Category:       < core | contrib >
-Module:         <module name>
+Category:       <XX core | contrib >
+Module:         <XX module name>
 Announced:      2025-XX-XX
-Credits:
-Affects:        <affected versions>
+Credits:        XX
+Affects:        <XX affected versions>
                 <e.g., "All supported versions of FreeBSD.", "FreeBSD
                 13.5 and later.", "FreeBSD 13.x", or "FreeBSD 14.3">
 Corrected:      2025-XX-XX XX:XX:XX UTC (stable/15, 15.0-STABLE)
@@ -25,31 +25,31 @@ following sections, please visit <URL:https://security.FreeBSD.org/>.
 
 I.   Background
 
-<brief description of what the affected bits are supposed to do>
+<XX brief description of what the affected bits are supposed to do>
 
 II.  Problem Description
 
-<detailed description of the problem>
+<XX detailed description of the problem>
 
 III. Impact
 
-<description as to why the above problem is bad>
+<XX description as to why the above problem is bad>
 
 IV.  Workaround
 
-<If no workaround exists:>
+<XX If no workaround exists:>
 No workaround is available.
 
-<... but some systems are unaffected:>
+<XX ... but some systems are unaffected:>
 No workaround is available.  <insert simple description of some
 systems that are not vulnerable>
 
-<If a workaround exists:>
-<insert workaround here>
+<XX If a workaround exists:>
+<XX insert workaround here>
 
 V.   Solution
 
-<insert solution here>
+<XX insert solution here>
 
 Upgrade your vulnerable system to a supported FreeBSD stable or
 release / security branch (releng) dated after the correction date.
@@ -84,7 +84,7 @@ FreeBSD release branches.
 a) Download the relevant patch from the location below, and verify the
 detached PGP signature using your PGP utility.
 
-[FreeBSD 13.3]
+[FreeBSD XX]
 # fetch https://security.FreeBSD.org/patches/SA-XX:XX/XXXX.patch
 # fetch https://security.FreeBSD.org/patches/SA-XX:XX/XXXX.patch.asc
 # gpg --verify XXXX.patch.asc
@@ -94,26 +94,26 @@ b) Apply the patch.  Execute the following commands as root:
 # cd /usr/src
 # patch < /path/to/patch
 
-<for a userland utility:>
+<XX for a userland utility:>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
-<for a daemons>
+<XX for a daemons>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
 Restart the applicable daemons, or reboot the system.
 
-<for a common library>
+<XX for a common library>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
 Restart all daemons that use the library, or reboot the system.
 
-<for a kernel vulnerability:>
+<XX for a kernel vulnerability:>
 
 c) Recompile your kernel as described in
 <URL:https://www.FreeBSD.org/handbook/kernelconfig.html>; and reboot the
@@ -150,7 +150,7 @@ nNNNNNN in the table above), run:
 
 VII. References
 
-<other info on vulnerability>
+<XX other info on vulnerability>
 
 <URL:https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-XXXX-XXXX>;
 
diff --git a/website/static/security/errata-template.txt b/website/static/security/errata-template.txt
index 670fb83fa3..e2f56ad2e9 100644
--- a/website/static/security/errata-template.txt
+++ b/website/static/security/errata-template.txt
@@ -1,14 +1,14 @@
 =============================================================================
-FreeBSD-EN-ERRATA_TEMPLATE                                      Errata Notice
+FreeBSD-EN-XX_ERRATA_TEMPLATE                                   Errata Notice
                                                           The FreeBSD Project
 
-Topic:
+Topic:          XX
 
-Category:       < core | contrib >
-Module:         <module name>
+Category:       <XX core | contrib >
+Module:         <XX module name>
 Announced:      2025-XX-XX
-Credits:
-Affects:        <affected versions>
+Credits:        XX
+Affects:        <XX affected versions>
                 <e.g., "All supported versions of FreeBSD.", "FreeBSD
                 13.5 and later.", "FreeBSD 13.x", or "FreeBSD 14.3">
 Corrected:      2025-XX-XX XX:XX:XX UTC (stable/15, 15.0-STABLE)
@@ -25,31 +25,31 @@ branches, and the following sections, please visit
 
 I.   Background
 
-<brief description of what the affected bits are supposed to do>
+<XX brief description of what the affected bits are supposed to do>
 
 II.  Problem Description
 
-<detailed description of the problem>
+<XX detailed description of the problem>
 
 III. Impact
 
-<description as to why the above problem is bad>
+<XX description as to why the above problem is bad>
 
 IV.  Workaround
 
-<If no workaround exists:>
+<XX If no workaround exists:>
 No workaround is available.
 
-<... but some systems are unaffected:>
+<XX ... but some systems are unaffected:>
 No workaround is available.  <insert simple description of some
 systems that are not vulnerable>
 
-<If a workaround exists:>
-<insert workaround here>
+<XX If a workaround exists:>
+<XX insert workaround here>
 
 V.   Solution
 
-<insert solution here>
+<XX insert solution here>
 
 Upgrade your system to a supported FreeBSD stable or release / security
 branch (releng) dated after the correction date.
@@ -84,7 +84,7 @@ FreeBSD release branches.
 a) Download the relevant patch from the location below, and verify the
 detached PGP signature using your PGP utility.
 
-[FreeBSD 13.3]
+[FreeBSD XX]
 # fetch https://security.FreeBSD.org/patches/EN-XX:XX/XXXX.patch
 # fetch https://security.FreeBSD.org/patches/EN-XX:XX/XXXX.patch.asc
 # gpg --verify XXXX.patch.asc
@@ -94,26 +94,26 @@ b) Apply the patch.  Execute the following commands as root:
 # cd /usr/src
 # patch < /path/to/patch
 
-<for a userland utility:>
+<XX for a userland utility:>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
-<for a daemons>
+<XX for a daemons>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
 Restart the applicable daemons, or reboot the system.
 
-<for a common library>
+<XX for a common library>
 
 c) Recompile the operating system using buildworld and installworld as
 described in <URL:https://www.FreeBSD.org/handbook/makeworld.html>.
 
 Restart all daemons that use the library, or reboot the system.
 
-<for a kernel bug:>
+<XX for a kernel bug:>
 
 c) Recompile your kernel as described in
 <URL:https://www.FreeBSD.org/handbook/kernelconfig.html>; and reboot the
@@ -150,7 +150,7 @@ nNNNNNN in the table above), run:
 
 VII. References
 
-<other info on the problem>
+<XX other info on the problem>
 
 <URL:https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=XXXXXX>;
 


home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?698b9b8d.3feb4.638dcca3>