git: 6d17f2d04302 - main - freebsd-update.8: Document CreateBootEnv

From: Mateusz Piotrowski <>
Date: Thu, 17 Feb 2022 09:29:14 UTC
The branch main has been updated by 0mp (doc, ports committer):


commit 6d17f2d04302af6408127b9f8a307e2977c6d086
Author:     Mateusz Piotrowski <>
AuthorDate: 2022-02-04 10:20:49 +0000
Commit:     Mateusz Piotrowski <>
CommitDate: 2022-02-17 09:26:59 +0000

    freebsd-update.8: Document CreateBootEnv
    Also, add bectl(8) to section "See Also". [1]
    PR:             261716
    Reviewed by:    debdrup,
    MFC after:      1 week
    Fixes:          f28f13890541 freebsd-update: create a ZFS boot environment on install
    Differential Revision:
    Co-authored-by: Tobias Rehbein <> [1]
 share/man/man5/freebsd-update.conf.5 | 56 +++++++++++++++++++++++++++++++++++-
 1 file changed, 55 insertions(+), 1 deletion(-)

diff --git a/share/man/man5/freebsd-update.conf.5 b/share/man/man5/freebsd-update.conf.5
index 498fa15e685f..9d33e9e25171 100644
--- a/share/man/man5/freebsd-update.conf.5
+++ b/share/man/man5/freebsd-update.conf.5
@@ -25,7 +25,7 @@
 .\" $FreeBSD$
-.Dd August 19, 2009
+.Dd February 17, 2022
 .Os FreeBSD
@@ -218,6 +218,59 @@ backup kernel, the
 .Cm freebsd-update
 rollback command will recreate the symbol files along with the old
+.It Cm CreateBootEnv
+The single parameter following this keyword must be
+.Dq yes
+.Dq no
+and specifies whether
+.Cm freebsd-update
+will create a new boot environment using
+.Xr bectl 8
+when installing patches.
+The name of the new boot environment consists of the current
+.Bd -literal -offset indent
+freebsd-version -ku | sort -V | tail -n 1
+and a timestamp:
+.Bd -literal -offset indent
+date +"%Y-%m-%d_%H%M%S"
+separated by a single dash, e.g.:
+.Bd -literal -offset indent
+.Cm freebsd-update
+does not attempt to create a boot environment
+if any of the following applies:
+.Bl -dash -compact
+ZFS is not used.
+The ZFS root is not set up for boot environments
+.Po see the check command of
+.Xr bectl 8
+for details
+.Pc .
+.Cm freebsd-update
+is running in a
+.Xr jail 8 .
+.Cm freebsd-update
+is updating a root directory selected via
+the basedir
+.Pq Fl b
+or jail
+.Pq Fl j
 .Bl -tag -width "/etc/freebsd-update.conf"
@@ -228,6 +281,7 @@ configuration file.
 .Xr sha256 1 ,
+.Xr bectl 8 ,
 .Xr freebsd-update 8
 .An Colin Percival Aq Mt