Bug 204449 - UUID(3) man page page lacks return value information
Summary: UUID(3) man page page lacks return value information
Status: Open
Alias: None
Product: Documentation
Classification: Unclassified
Component: Manual Pages (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Guangyuan Yang
Keywords: easy, patch
Depends on:
Reported: 2015-11-10 20:10 UTC by Michael Cress
Modified: 2021-10-01 07:09 UTC (History)
4 users (show)

See Also:

uuid(3) patch (2.00 KB, patch)
2021-09-20 02:20 UTC, Felix Johnson
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
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 freebsd_triage 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.