d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

bectl(8): add description for create subcommand

Browse Source 
In commit r345845, a portion of documentation for the create subcommand was
removed. Specifically, for creating a snapshot of an existing boot
environment. bectl even has a test-case for this functionality.

Removing the sub-command description was discussed in PR 235850.

This patch brings back the second "create" description that was originally
in place. Albeit, with a few wording/clarifying changes.

Submitted by:	Rob Fairbanks <rob.fx907 gmail com>
Reviewed by:	kevans
MFC after:	3 days
Differential Revision:	https://reviews.freebsd.org/D20249
This commit is contained in:
kevans 2019-05-22 23:07:40 +00:00
parent c9c804add4
commit 4af3cc46e2
1 changed files with 19 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
sbin/bectl/bectl.8
View File

@ -18,7 +18,7 @@
.\" .\"
.\" $FreeBSD$ .\" $FreeBSD$
.\" .\"
.Dd April 3, 2019 .Dd May 12, 2019
.Dt BECTL 8 .Dt BECTL 8
.Os .Os
.Sh NAME .Sh NAME
@ -35,6 +35,10 @@
.Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot .Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot
.Ar newBeName .Ar newBeName
.Nm .Nm
.Cm create
.Op Fl r
.Ar beName@snapshot
.Nm
.Cm destroy .Cm destroy
.Op Fl \&Fo .Op Fl \&Fo
.Ar beName Ns Op Cm @ Ns Ar snapshot .Ar beName Ns Op Cm @ Ns Ar snapshot
@ -121,6 +125,20 @@ If
.Nm .Nm
is creating from another boot environment, a snapshot of that boot environment will be created to clone from. is creating from another boot environment, a snapshot of that boot environment will be created to clone from.
.It Xo .It Xo
.Cm create
.Op Fl r
.Ar beName@snapshot
.Xc
Create a snapshot of the boot environment named
.Ar beName .
.Pp
If the
.Fl r
flag is given, a recursive snapshot of the boot environment will be created.
A snapshot is created for each descendant dataset of the boot environment.
.Pp
No new boot environment is created with this command.
.It Xo
.Cm destroy .Cm destroy
.Op Fl \&Fo .Op Fl \&Fo
.Ar beName Ns Op Cm @ Ns Ar snapshot .Ar beName Ns Op Cm @ Ns Ar snapshot