Bug 204449

Summary: UUID(3) man page page lacks return value information
Product: Documentation Reporter: Michael Cress <michael.cress>
Component: Manual PagesAssignee: Guangyuan Yang <ygy>
Status: Closed FIXED    
Severity: Affects Only Me CC: doc, felix.the.red, michael.cress, ygy
Priority: --- Keywords: easy, patch
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
uuid(3) patch none

Description Michael Cress 2015-11-10 20:10:50 UTC 
"man 3 uuid" lists many functions relating to UUIDs. Most of these functions have a void return type in the function signature, with the result of the call being passed to a uint32_t *status found in the function parameters. The meaning of these status values are documented in the Return Values sections.

For those functions whose signatures return an int32_t or uint16_t, no information is listed regarding their meaning. The specific functions that require return value documentation are:

1.) int32_t uuid_compare(const	uuid_t *uuid1, const uuid_t *uuid2, uint32_t *status);

2.) int32_t uuid_equal(const uuid_t *uuid1, const uuid_t *uuid2, uint32_t *status);

3.) uint16_t uuid_hash(const uuid_t *uuid, uint32_t *status);

4.) int32_t uuid_is_nil(const uuid_t *uuid, uint32_t *status);

This information can also be viewed online at https://www.freebsd.org/cgi/man.cgi?query=uuid
Comment 1 Felix Johnson 2021-09-20 02:20:16 UTC 
Created attachment 228034 [details]
uuid(3) patch

Document return values for uuid_compare, uuid_equal, uuid_is_nil, and uuid_hash.
Comment 2 commit-hook freebsd_committer freebsd_triage 2021-11-19 08:59:34 UTC 
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=f6842865d3367217f2df3e5ae7ecb5b66caf9451

commit f6842865d3367217f2df3e5ae7ecb5b66caf9451
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-19 08:42:49 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-19 08:58:34 +0000

    uuid(3): Document return values

    PR:             204449
    MFC after:      3 days
    Reported by:    Michael Cress <michael.cress@cress.us>

 lib/libc/uuid/uuid.3 | 63 ++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 54 insertions(+), 9 deletions(-)
Comment 3 commit-hook freebsd_committer freebsd_triage 2021-11-22 00:44:11 UTC 
A commit in branch stable/13 references this bug:

URL: https://cgit.FreeBSD.org/src/commit/?id=c8342584596a0354df6414a0747afe0dfed485e0

commit c8342584596a0354df6414a0747afe0dfed485e0
Author:     Felix Johnson <felix.the.red@gmail.com>
AuthorDate: 2021-11-19 08:42:49 +0000
Commit:     Guangyuan Yang <ygy@FreeBSD.org>
CommitDate: 2021-11-22 00:43:31 +0000

    uuid(3): Document return values

    PR:             204449
    Reported by:    Michael Cress <michael.cress@cress.us>

    (cherry picked from commit f6842865d3367217f2df3e5ae7ecb5b66caf9451)

 lib/libc/uuid/uuid.3 | 63 ++++++++++++++++++++++++++++++++++++++++++++--------
 1 file changed, 54 insertions(+), 9 deletions(-)