svn commit: r337597 - projects/bectl/lib/libbe

[Kyle Evans]

Author: kevans
Date: Sat Aug 11 01:05:44 2018
New Revision: 337597
URL: https://svnweb.freebsd.org/changeset/base/337597

Log:
  libbe(3): Bring man page back into reality

Modified:
  projects/bectl/lib/libbe/libbe.3

Modified: projects/bectl/lib/libbe/libbe.3
==============================================================================
--- projects/bectl/lib/libbe/libbe.3	Sat Aug 11 01:02:27 2018	(r337596)
+++ projects/bectl/lib/libbe/libbe.3	Sat Aug 11 01:05:44 2018	(r337597)
@@ -32,7 +32,7 @@
 .\"
 .\" $FreeBSD$
 .\"
-.Dd August 6, 2018
+.Dd August 10, 2018
 .Dt LIBBE 3
 .Os
 .Sh NAME
@@ -75,20 +75,20 @@ of state to be retained, such as errors from previous 
 .Fn  libbe_handle_t "libbe_handle_t " ;
 .Pp
 .Ft int
-.Fn be_create "libbe_handle_t *, char *" ;
+.Fn be_create "libbe_handle_t *, const char *" ;
 .Pp
 .Ft int
 .Fn be_create_from_existing "libbe_handle_t *, const char *, const char *" ;
 .Pp
 .Ft int
-.Fn be_rename "libbe_handle_t *, char *, char *" ;
+.Fn be_rename "libbe_handle_t *, const char *, const char *" ;
 .Pp
 .\" TODO: Write up of destroy options
 .\" typedef enum {
 .\"	BE_DESTROY_FORCE = 1 << 0,
 .\" } be_destroy_opt_t;
 .Ft int
-.Fn be_destroy "libbe_handle_t *, char *, int" ;
+.Fn be_destroy "libbe_handle_t *, const char *, int" ;
 .Pp
 .Ft void
 .Fn be_nicenum "uint64_t, char *, size_t" ;
@@ -129,15 +129,12 @@ of state to be retained, such as errors from previous 
 .Fn be_exists "libbe_handle_t *, char *" ;
 .Pp
 .Ft int
-.Fn be_export "libbe_handle_t *, char *, int fd" ;
+.Fn be_export "libbe_handle_t *, const char *, int fd" ;
 .Pp
 .Ft int
-.Fn be_import "libbe_handle_t *, char *, int fd" ;
+.Fn be_import "libbe_handle_t *, const char *, int fd" ;
 .Pp
 .Ft int
-.Fn be_add_child "libbe_handle_t *, char *, bool" ;
-.Pp
-.Ft int
 .Fn be_prop_list_alloc "nvlist_t **" ;
 .Pp
 .Ft int
@@ -151,36 +148,6 @@ of state to be retained, such as errors from previous 
 .Pp
 .Ft void
 .Fn be_prop_list_free "nvlist_t *" ;
-.\" .Ft void
-.\" .Fn mp_mfree "MINT *mp" ;
-.\" .Bd -ragged -offset indent
-.\" .Fn mp_itom
-.\" returns an
-.\" .Vt MINT
-.\" with the value of
-.\" .Fa n .
-.\" .Fn mp_xtom
-.\" returns an
-.\" .Vt MINT
-.\" with the value of
-.\" .Fa s ,
-.\" which is treated to be in hexadecimal.
-.\" The return values from
-.\" .Fn mp_itom
-.\" and
-.\" .Fn mp_xtom
-.\" must be released with
-.\" .Fn mp_mfree
-.\" when they are no longer needed.
-.\" .Fn mp_mtox
-.\" returns a null-terminated hexadecimal string having the value of
-.\" .Fa mp ;
-.\" its return value must be released with
-.\" .Fn free
-.\" .Pq Xr free 3
-.\" when it is no longer needed.
-.\" .Ed
-.\" .Pp
 .Sh DIAGNOSTICS
 Upon error, one of the following values will be returned.
 .\" TODO: make each entry on its own line.
@@ -202,6 +169,8 @@ BE_ERR_NOMOUNT,
 BE_ERR_ZFSOPEN,
 BE_ERR_ZFSCLONE,
 BE_ERR_IO,
+BE_ERR_NOPOOL,
+BE_ERR_NOMEM,
 BE_ERR_UNKNOWN
 .Ed
 .Sh SEE ALSO