From nobody Thu Feb 17 09:29:14 2022 X-Original-To: dev-commits-src-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 C7D6019C455B; Thu, 17 Feb 2022 09:29:14 +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 "R3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4JzqK651ksz4VYb; Thu, 17 Feb 2022 09:29:14 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645090154; 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=sWfbJreV41f8c7SWPQuIh9h29nC6H+zI6gHCofmh3b4=; b=VuaL5bFnO7YhiIooBQJHc8zpxLywIykJQML30q3PxfKf5hn3HFtgc6rCghD0Sa6mkIb7dU 7gBclrHsxE0Yef5BrGm4WWHVrbT581+VdrpTnH/Onuk5Ug9d9G00PFPXWl7iSlNaQ13x4R mc1T/f2LYVTqNlOkbEnQAQr+peoR6lfKbS5Qkths1WBhgXcx9cSJOqMUqQkA4F+c9ZUUiD M49c+lab0Bc0ylvM2mRC/vbzqqiU63LrV58vF8GK0PyvOcCoATeKWoIz36lw8oUkw7Kld3 /isIg2aFesOo3enLT2yFZf2No7w8jv3yb31TnKcZQfaB8MU/wG6DgC1tSeUbbw== 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 7E23027605; Thu, 17 Feb 2022 09:29:14 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.16.1/8.16.1) with ESMTP id 21H9TE6u000193; Thu, 17 Feb 2022 09:29:14 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.16.1/8.16.1/Submit) id 21H9TEQ2000192; Thu, 17 Feb 2022 09:29:14 GMT (envelope-from git) Date: Thu, 17 Feb 2022 09:29:14 GMT Message-Id: <202202170929.21H9TEQ2000192@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org From: Mateusz Piotrowski <0mp@FreeBSD.org> Subject: git: 6d17f2d04302 - main - freebsd-update.8: Document CreateBootEnv List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: Sender: owner-dev-commits-src-all@freebsd.org X-BeenThere: dev-commits-src-all@freebsd.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: 0mp X-Git-Repository: src X-Git-Refname: refs/heads/main X-Git-Reftype: branch X-Git-Commit: 6d17f2d04302af6408127b9f8a307e2977c6d086 Auto-Submitted: auto-generated ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1645090154; 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=sWfbJreV41f8c7SWPQuIh9h29nC6H+zI6gHCofmh3b4=; b=jgJK7rEW6MViJhb6nRQMLg1LBYg0Zi8bd/2g+V/V5/SPNttevGjRbEt+E2MJfOL1trCwYS ZXs6hHUWx2NZ3oBhPaX0njcjz457eoTazP4a34+N2ZqgbzTTbOutmu7ud3z9fW1VbkfJK7 sEsw4C2+tdEiNBSa3FIIr4m/5+J/49ivMxoLr5BgWXc6WCXJjsDo4fIeu292ruyCMMkiVA s0g2lYrx5ziYNXzMkHtONH3x0ItX1T102lbJ/IUq7z+v3QakB9TVfGlmNObqjwwCBCQYVC EmdECcndlkR6mXZco/CAxAslMDkLYzi7+sL20kh3KTM2CccXPSwK+wrO9Sp3og== ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1645090154; a=rsa-sha256; cv=none; b=mcTHnfOT0gsGn1mE85W0VLCtmUGe9Xb1EoaJuxXlTXm/0MPbI9/UMEEvjgwIHHsga+haj2 GrZjVtlqk5Nmg/11eX2GNd/HNQl+OcM0UiKqjMhv1+U1rrcMSO6828dFR7PucrXnAjaTQH VAYnbalHg6XqyjL+HgkWIsHIJci+8v4Nq7By+A/m5fFjnEgi4cGWumRlihdZiTfmywJgbt ATZ7cu6NgicECLw8v/+3fYNX7YOjqKS61wUdH/ODFE46hCMXMUN9+eQJRmMId0fIfC2WEs 9HWrt++O7Px0tb9VB8yEjdfYXX0bzxg/kuP6OXylMiIA6MXPlTGl/JloGzWX8g== ARC-Authentication-Results: i=1; mx1.freebsd.org; none X-ThisMailContainsUnwantedMimeParts: N The branch main has been updated by 0mp (doc, ports committer): URL: https://cgit.FreeBSD.org/src/commit/?id=6d17f2d04302af6408127b9f8a307e2977c6d086 commit 6d17f2d04302af6408127b9f8a307e2977c6d086 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-02-04 10:20:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> 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, pauamma_gundo.com MFC after: 1 week Fixes: f28f13890541 freebsd-update: create a ZFS boot environment on install Differential Revision: https://reviews.freebsd.org/D34169 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 .Dt FREEBSD-UPDATE.CONF 5 .Os FreeBSD .Sh NAME @@ -218,6 +218,59 @@ backup kernel, the .Cm freebsd-update rollback command will recreate the symbol files along with the old kernel. +.It Cm CreateBootEnv +The single parameter following this keyword must be +.Dq yes +or +.Dq no +and specifies whether +.Cm freebsd-update +will create a new boot environment using +.Xr bectl 8 +when installing patches. +.Pp +The name of the new boot environment consists of the current +.Fx +version: +.Bd -literal -offset indent +freebsd-version -ku | sort -V | tail -n 1 +.Ed +.Pp +and a timestamp: +.Bd -literal -offset indent +date +"%Y-%m-%d_%H%M%S" +.Ed +.Pp +separated by a single dash, e.g.: +.Bd -literal -offset indent +13.0-RELEASE-p7_2022-02-16_141502 +.Ed +.Pp +.Cm freebsd-update +does not attempt to create a boot environment +if any of the following applies: +.Pp +.Bl -dash -compact +.It +ZFS is not used. +.It +The ZFS root is not set up for boot environments +.Po see the check command of +.Xr bectl 8 +for details +.Pc . +.It +.Cm freebsd-update +is running in a +.Xr jail 8 . +.It +.Cm freebsd-update +is updating a root directory selected via +the basedir +.Pq Fl b +or jail +.Pq Fl j +flags. .El .Sh FILES .Bl -tag -width "/etc/freebsd-update.conf" @@ -228,6 +281,7 @@ configuration file. .El .Sh SEE ALSO .Xr sha256 1 , +.Xr bectl 8 , .Xr freebsd-update 8 .Sh AUTHORS .An Colin Percival Aq Mt cperciva@FreeBSD.org