svn commit: r348127 - head/sbin/bectl

[Kyle Evans]

Author: kevans
Date: Wed May 22 23:07:40 2019
New Revision: 348127
URL: https://svnweb.freebsd.org/changeset/base/348127

Log:
  bectl(8): add description for create subcommand
  
  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

Modified:
  head/sbin/bectl/bectl.8

Modified: head/sbin/bectl/bectl.8
==============================================================================
--- head/sbin/bectl/bectl.8	Wed May 22 22:56:05 2019	(r348126)
+++ head/sbin/bectl/bectl.8	Wed May 22 23:07:40 2019	(r348127)
@@ -18,7 +18,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd April 3, 2019
+.Dd May 12, 2019
 .Dt BECTL 8
 .Os
 .Sh NAME
@@ -35,6 +35,10 @@
 .Op Fl e Brq Ar nonActiveBe | Ar beName Ns Cm @ Ns Ar snapshot
 .Ar newBeName
 .Nm
+.Cm create
+.Op Fl r
+.Ar beName at snapshot
+.Nm
 .Cm destroy
 .Op Fl \&Fo
 .Ar beName Ns Op Cm @ Ns Ar snapshot
@@ -120,6 +124,20 @@ Otherwise, the new environment will be created from th
 If
 .Nm
 is creating from another boot environment, a snapshot of that boot environment will be created to clone from.
+.It Xo
+.Cm create
+.Op Fl r
+.Ar beName at 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
 .Op Fl \&Fo