Created attachment 231555 [details] freebsd-update.conf.5: document CreateBootEnv keyword The description of the new keyword `CreateBootEnv` is based on the commit message of the commit f28f138905416c45ebaa6429f44a0b88a72f54b1 in the freebsd-src repository.
(In reply to Tobias Rehbein from comment #0) Good catch, thanks, but someone was working on it already. :-) The one thing I see in your suggested change that's not in the other is the bectl see-also. I've asked them to add that.
A commit in branch main references this bug: 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 <tobias.rehbein@web.de> [1] share/man/man5/freebsd-update.conf.5 | 56 +++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-)
A commit in branch stable/13 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=8a3c868ab4e66ace70367b0ba943a324841d9a63 commit 8a3c868ab4e66ace70367b0ba943a324841d9a63 Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-02-04 10:20:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-02-24 13:46:24 +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 <tobias.rehbein@web.de> [1] (cherry picked from commit 6d17f2d04302af6408127b9f8a307e2977c6d086) share/man/man5/freebsd-update.conf.5 | 56 +++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-)
A commit in branch stable/12 references this bug: URL: https://cgit.FreeBSD.org/src/commit/?id=d639807e77987dd304560da7bbb06e1ffb40db4a commit d639807e77987dd304560da7bbb06e1ffb40db4a Author: Mateusz Piotrowski <0mp@FreeBSD.org> AuthorDate: 2022-02-04 10:20:49 +0000 Commit: Mateusz Piotrowski <0mp@FreeBSD.org> CommitDate: 2022-02-24 13:47:16 +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 <tobias.rehbein@web.de> [1] (cherry picked from commit 6d17f2d04302af6408127b9f8a307e2977c6d086) share/man/man5/freebsd-update.conf.5 | 56 +++++++++++++++++++++++++++++++++++- 1 file changed, 55 insertions(+), 1 deletion(-)
Please also pull this into releng/12.3. It's been pulled into stable/12 (and also stable/13 and releng/13.1) but not 12.3. I was not aware this functionality had made it into 12.3 until reading about a related bugfix in FreeBSD-EN-22:09.freebsd-update.
(In reply to Andrew Daugherity from comment #5) Hey Andrew, I'm not sure if a manual page update is important enough to justify an errata notice on a release. We can ask though.
(In reply to Mateusz Piotrowski from comment #6) Hmm, I didn't think of it that way, just that it seemed an oversight to ship the feature without the docs -- e.g. upgrade from 12.2 to 12.3, then freebsd-update starts creating boot environments -- might be surprising. A pleasant one, perhaps, but still... Could this be in scope of a new revision of EN-22:09, or worthy of a mention in the Release Notes? (If the latter, probably worth also doing so for the upcoming 13.1.) I should note that no version of the online man pages (even 14.0-CURRENT) seems to have the updated freebsd-update.conf(5). I don't want to create an undue burden on the maintainers, just hoping to help others avoid confusion. :-)