[Bug 204449] UUID(3) man page page lacks return value information

[bugzilla-noreply at freebsd.org]

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=204449

            Bug ID: 204449
           Summary: UUID(3) man page page lacks return value information
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: freebsd-doc at FreeBSD.org
          Reporter: michael.cress at cress.us

"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

-- 
You are receiving this mail because:
You are the assignee for the bug.