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

libbe(3): document be_snapshot()

Browse Source 
While toying around with lua bindings for libbe(3), I discovered that I
apparently never documented this, despite having documented
be_is_auto_snapshot_name that references it.

MFC after:	1 week
This commit is contained in:
Kyle Evans 2020-10-18 23:42:00 +00:00
parent 5773e924e7
commit 513bd2fc81
Notes: svn2git 2020-12-20 02:59:44 +00:00 
svn path=/head/; revision=366820
1 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
lib/libbe/libbe.3
View File

@ -58,6 +58,9 @@
.Ft const char * Ns
.Fn be_root_path "libbe_handle_t *hdl"
.Pp
.Ft int Ns
.Fn be_snapshot "libbe_handle_t *hdl" "const char *be_name" "const char *snap_name" "bool recursive" "char *result"
.Pp
.Ft bool Ns
.Fn be_is_auto_snapshot_name "libbe_handle_t *hdl" "const char *snap"
.Pp
@ -220,6 +223,30 @@ The
function returns the boot environment root path.
.Pp
The
.Fn be_snapshot
function creates a snapshot of
.Fa be_name
named
.Fa snap_name .
A
.Dv NULL
.Fa snap_name
may be used, indicating that
.Fn be_snaphot
should derive the snapshot name from the current date and time.
If
.Fa recursive
is set, then
.Fn be_snapshot
will recursively snapshot the dataset.
If
.Fa result
is not
.Dv NULL ,
then it will be populated with the final
.Dq Fa be_name Ns @ Ns Fa snap_name .
.Pp
The
.Fn be_is_auto_snapshot_name
function is used to determine if the given snapshot name matches the format that
the