summaryrefslogtreecommitdiffstats
path: root/libuuid
diff options
context:
space:
mode:
authorKarel Zak2018-03-09 10:49:46 +0100
committerKarel Zak2018-03-09 10:49:46 +0100
commitb9656e409a7b702f318eaaf01b61fd359c304443 (patch)
tree4a62fd806709989cddaa34f83258f47cac6905c6 /libuuid
parentMerge branch 'setpriv-example' of https://github.com/yrro/util-linux (diff)
downloadkernel-qcow2-util-linux-b9656e409a7b702f318eaaf01b61fd359c304443.tar.gz
kernel-qcow2-util-linux-b9656e409a7b702f318eaaf01b61fd359c304443.tar.xz
kernel-qcow2-util-linux-b9656e409a7b702f318eaaf01b61fd359c304443.zip
libuuid: make "CONFORMING TO" man sections more explicit
Addresses: https://github.com/karelzak/util-linux/issues/592 Signed-off-by: Karel Zak <kzak@redhat.com>
Diffstat (limited to 'libuuid')
-rw-r--r--libuuid/man/uuid.33
-rw-r--r--libuuid/man/uuid_generate.313
-rw-r--r--libuuid/man/uuid_parse.33
-rw-r--r--libuuid/man/uuid_unparse.32
4 files changed, 17 insertions, 4 deletions
diff --git a/libuuid/man/uuid.3 b/libuuid/man/uuid.3
index 92e05bb7e..13ab7a8f4 100644
--- a/libuuid/man/uuid.3
+++ b/libuuid/man/uuid.3
@@ -47,7 +47,8 @@ be used, for instance, to generate unique HTTP cookies across multiple
web servers without communication between the servers, and without fear
of a name clash.
.SH "CONFORMING TO"
-OSF DCE 1.1
+This library generates UUIDs compatible OSF DCE 1.1, and hash based UUIDs V3 and
+V5 compatible with RFC-4122.
.SH AUTHOR
Theodore Y.\& Ts'o
.SH AVAILABILITY
diff --git a/libuuid/man/uuid_generate.3 b/libuuid/man/uuid_generate.3
index 9b7796dc9..a5b0ab701 100644
--- a/libuuid/man/uuid_generate.3
+++ b/libuuid/man/uuid_generate.3
@@ -41,6 +41,8 @@ uuid_generate_time_safe \- create a new unique UUID value
.BI "void uuid_generate_random(uuid_t " out );
.BI "void uuid_generate_time(uuid_t " out );
.BI "int uuid_generate_time_safe(uuid_t " out );
+.BI "void uuid_generate_md5(uuid_t " out ", const uuid_t " ns ", const char " *name ", size_t " len ");
+.BI "void uuid_generate_sha1(uuid_t " out ", const uuid_t " ns ", const char " *name ", size_t " len ");
.fi
.SH DESCRIPTION
The
@@ -100,13 +102,22 @@ the universe according to Carl Sagan's
The new UUID can reasonably be considered unique among all UUIDs created
on the local system, and among UUIDs created on other systems in the past
and in the future.
+.sp
+The
+.B uuid_generate_md5
+and
+.B uuid_generate_sha1
+functions generate an MD5 and SHA1 hashed (predictable) UUID based on a
+well-known UUID providing the namespace and an arbitrary binary string. The UUIDs
+confirm to V3 and V5 UUIDs per RFC-4122.
.SH RETURN VALUE
The newly created UUID is returned in the memory location pointed to by
.IR out .
.B uuid_generate_time_safe
returns zero if the UUID has been generated in a safe manner, \-1 otherwise.
.SH "CONFORMING TO"
-OSF DCE 1.1
+This library generates UUIDs compatible OSF DCE 1.1, and hash based UUIDs V3 and
+V5 compatible with RFC-4122.
.SH AUTHOR
Theodore Y.\& Ts'o
.SH AVAILABILITY
diff --git a/libuuid/man/uuid_parse.3 b/libuuid/man/uuid_parse.3
index 6e7c47c7a..50b2c87b6 100644
--- a/libuuid/man/uuid_parse.3
+++ b/libuuid/man/uuid_parse.3
@@ -53,7 +53,8 @@ stored in the location pointed to by
.IR uu ,
otherwise \-1 is returned.
.SH "CONFORMING TO"
-OSF DCE 1.1
+This library parses UUIDs compatible OSF DCE 1.1, and hash based UUIDs V3 and
+V5 compatible with RFC-4122.
.SH AUTHOR
Theodore Y.\& Ts'o
.SH AVAILABILITY
diff --git a/libuuid/man/uuid_unparse.3 b/libuuid/man/uuid_unparse.3
index 0c5f09fcf..7da02079f 100644
--- a/libuuid/man/uuid_unparse.3
+++ b/libuuid/man/uuid_unparse.3
@@ -61,7 +61,7 @@ and
.B uuid_unparse_lower
may be used.
.SH "CONFORMING TO"
-OSF DCE 1.1
+This library unparses UUIDs compatible with OSF DCE 1.1.
.SH AUTHOR
Theodore Y.\& Ts'o
.SH AVAILABILITY