Skip site navigation (1)Skip section navigation (2)
Date:      Sat, 14 Nov 2020 15:21:20 +0000 (UTC)
From:      Kyle Evans <kevans@FreeBSD.org>
To:        src-committers@freebsd.org, svn-src-all@freebsd.org, svn-src-stable@freebsd.org, svn-src-stable-12@freebsd.org
Subject:   svn commit: r367682 - in stable/12: lib/libbe tools/build/mk
Message-ID:  <202011141521.0AEFLKgU098624@repo.freebsd.org>

next in thread | raw e-mail | index | archive | help
Author: kevans
Date: Sat Nov 14 15:21:20 2020
New Revision: 367682
URL: https://svnweb.freebsd.org/changeset/base/367682

Log:
  MFC r366820-r366821: libbe(3) documentation improvements
  
  r366820:
  libbe(3): document be_snapshot()
  
  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.
  
  r366821:
  libbe(3): install MLINKS for all of the functions provided

Modified:
  stable/12/lib/libbe/Makefile
  stable/12/lib/libbe/libbe.3
  stable/12/tools/build/mk/OptionalObsoleteFiles.inc
Directory Properties:
  stable/12/   (props changed)

Modified: stable/12/lib/libbe/Makefile
==============================================================================
--- stable/12/lib/libbe/Makefile	Sat Nov 14 15:19:36 2020	(r367681)
+++ stable/12/lib/libbe/Makefile	Sat Nov 14 15:21:20 2020	(r367682)
@@ -12,6 +12,41 @@ SHLIB_MINOR=	0
 SRCS=		be.c be_access.c be_error.c be_info.c
 INCS=		be.h
 MAN=		libbe.3
+MLINKS+=	libbe.3 be_activate.3
+MLINKS+=	libbe.3 be_active_name.3
+MLINKS+=	libbe.3 be_active_path.3
+MLINKS+=	libbe.3 be_create_depth.3
+MLINKS+=	libbe.3 be_create_from_existing_snap.3
+MLINKS+=	libbe.3 be_create_from_existing.3
+MLINKS+=	libbe.3 be_create.3
+MLINKS+=	libbe.3 be_deactivate.3
+MLINKS+=	libbe.3 be_destroy.3
+MLINKS+=	libbe.3 be_exists.3
+MLINKS+=	libbe.3 be_export.3
+MLINKS+=	libbe.3 be_get_bootenv_props.3
+MLINKS+=	libbe.3 be_get_dataset_props.3
+MLINKS+=	libbe.3 be_get_dataset_snapshots.3
+MLINKS+=	libbe.3 be_import.3
+MLINKS+=	libbe.3 be_is_auto_snapshot_name.3
+MLINKS+=	libbe.3 be_mount.3
+MLINKS+=	libbe.3 be_mounted_at.3
+MLINKS+=	libbe.3 be_nextboot_name.3
+MLINKS+=	libbe.3 be_nextboot_path.3
+MLINKS+=	libbe.3 be_nicenum.3
+MLINKS+=	libbe.3 be_prop_list_alloc.3
+MLINKS+=	libbe.3 be_prop_list_free.3
+MLINKS+=	libbe.3 be_rename.3
+MLINKS+=	libbe.3 be_root_concat.3
+MLINKS+=	libbe.3 be_root_path.3
+MLINKS+=	libbe.3 be_snapshot.3
+MLINKS+=	libbe.3 be_unmount.3
+MLINKS+=	libbe.3 be_validate_name.3
+MLINKS+=	libbe.3 be_validate_snap.3
+MLINKS+=	libbe.3 libbe_close.3
+MLINKS+=	libbe.3 libbe_errno.3
+MLINKS+=	libbe.3 libbe_error_description.3
+MLINKS+=	libbe.3 libbe_init.3
+MLINKS+=	libbe.3 libbe_print_on_error.3
 
 WARNS?=	2
 IGNORE_PRAGMA=	yes

Modified: stable/12/lib/libbe/libbe.3
==============================================================================
--- stable/12/lib/libbe/libbe.3	Sat Nov 14 15:19:36 2020	(r367681)
+++ stable/12/lib/libbe/libbe.3	Sat Nov 14 15:21:20 2020	(r367682)
@@ -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
@@ -214,6 +217,30 @@ active on reboot.
 The
 .Fn be_root_path
 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

Modified: stable/12/tools/build/mk/OptionalObsoleteFiles.inc
==============================================================================
--- stable/12/tools/build/mk/OptionalObsoleteFiles.inc	Sat Nov 14 15:19:36 2020	(r367681)
+++ stable/12/tools/build/mk/OptionalObsoleteFiles.inc	Sat Nov 14 15:21:20 2020	(r367682)
@@ -1394,6 +1394,41 @@ OLD_LIBS+=usr/lib32/libzpool.so.2
 OLD_FILES+=usr/sbin/zfsd
 OLD_FILES+=usr/sbin/zhack
 OLD_FILES+=usr/sbin/zdb
+OLD_FILES+=usr/share/man/man3/be_activate.3.gz
+OLD_FILES+=usr/share/man/man3/be_active_name.3.gz
+OLD_FILES+=usr/share/man/man3/be_active_path.3.gz
+OLD_FILES+=usr/share/man/man3/be_create_depth.3.gz
+OLD_FILES+=usr/share/man/man3/be_create_from_existing_snap.3.gz
+OLD_FILES+=usr/share/man/man3/be_create_from_existing.3.gz
+OLD_FILES+=usr/share/man/man3/be_create.3.gz
+OLD_FILES+=usr/share/man/man3/be_deactivate.3.gz
+OLD_FILES+=usr/share/man/man3/be_destroy.3.gz
+OLD_FILES+=usr/share/man/man3/be_exists.3.gz
+OLD_FILES+=usr/share/man/man3/be_export.3.gz
+OLD_FILES+=usr/share/man/man3/be_get_bootenv_props.3.gz
+OLD_FILES+=usr/share/man/man3/be_get_dataset_props.3.gz
+OLD_FILES+=usr/share/man/man3/be_get_dataset_snapshots.3.gz
+OLD_FILES+=usr/share/man/man3/be_import.3.gz
+OLD_FILES+=usr/share/man/man3/be_is_auto_snapshot_name.3.gz
+OLD_FILES+=usr/share/man/man3/be_mount.3.gz
+OLD_FILES+=usr/share/man/man3/be_mounted_at.3.gz
+OLD_FILES+=usr/share/man/man3/be_nextboot_name.3.gz
+OLD_FILES+=usr/share/man/man3/be_nextboot_path.3.gz
+OLD_FILES+=usr/share/man/man3/be_nicenum.3.gz
+OLD_FILES+=usr/share/man/man3/be_prop_list_alloc.3.gz
+OLD_FILES+=usr/share/man/man3/be_prop_list_free.3.gz
+OLD_FILES+=usr/share/man/man3/be_rename.3.gz
+OLD_FILES+=usr/share/man/man3/be_root_concat.3.gz
+OLD_FILES+=usr/share/man/man3/be_root_path.3.gz
+OLD_FILES+=usr/share/man/man3/be_snapshot.3.gz
+OLD_FILES+=usr/share/man/man3/be_unmount.3.gz
+OLD_FILES+=usr/share/man/man3/be_validate_name.3.gz
+OLD_FILES+=usr/share/man/man3/be_validate_snap.3.gz
+OLD_FILES+=usr/share/man/man3/libbe_close.3.gz
+OLD_FILES+=usr/share/man/man3/libbe_errno.3.gz
+OLD_FILES+=usr/share/man/man3/libbe_error_description.3.gz
+OLD_FILES+=usr/share/man/man3/libbe_init.3.gz
+OLD_FILES+=usr/share/man/man3/libbe_print_on_error.3.gz
 OLD_FILES+=usr/share/man/man3/libbe.3.gz
 OLD_FILES+=usr/share/man/man7/zpool-features.7.gz
 OLD_FILES+=usr/share/man/man8/bectl.8.gz



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202011141521.0AEFLKgU098624>