]> git.ipfire.org Git - thirdparty/util-linux.git/commitdiff
libuuid: make "CONFORMING TO" man sections more explicit
authorKarel Zak <kzak@redhat.com>
Fri, 9 Mar 2018 09:49:46 +0000 (10:49 +0100)
committerKarel Zak <kzak@redhat.com>
Fri, 9 Mar 2018 09:49:46 +0000 (10:49 +0100)
Addresses: https://github.com/karelzak/util-linux/issues/592
Signed-off-by: Karel Zak <kzak@redhat.com>
libuuid/man/uuid.3
libuuid/man/uuid_generate.3
libuuid/man/uuid_parse.3
libuuid/man/uuid_unparse.3

index 92e05bb7e4f13f939881f59e1225313a0a04c07b..13ab7a8f4906612bd4dcc3dfcc4e4a54fc6d9905 100644 (file)
@@ -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
index 9b7796dc9074cbfe69f784c1d727ff86ba615689..a5b0ab7011a2bdbcaea9d65c6806b322c286c7af 100644 (file)
@@ -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
index 6e7c47c7a6c41e4c31173833ef01e31ec96cb64d..50b2c87b6b934050ee575c91c44b8a0ccb032430 100644 (file)
@@ -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
index 0c5f09fcf213a1d233e218323f0d09cee558ca13..7da02079f31e96f2b31ef6dac8da072fdca1bfb8 100644 (file)
@@ -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