From owner-freebsd-doc@freebsd.org  Tue Nov 10 20:10:50 2015
Return-Path: <owner-freebsd-doc@freebsd.org>
Delivered-To: freebsd-doc@mailman.ysv.freebsd.org
Received: from mx1.freebsd.org (mx1.freebsd.org
 [IPv6:2001:1900:2254:206a::19:1])
 by mailman.ysv.freebsd.org (Postfix) with ESMTP id 60606A2B13B
 for <freebsd-doc@mailman.ysv.freebsd.org>;
 Tue, 10 Nov 2015 20:10:50 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from kenobi.freebsd.org (kenobi.freebsd.org
 [IPv6:2001:1900:2254:206a::16:76])
 (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
 (Client did not present a certificate)
 by mx1.freebsd.org (Postfix) with ESMTPS id 42D9D1053
 for <freebsd-doc@FreeBSD.org>; Tue, 10 Nov 2015 20:10:50 +0000 (UTC)
 (envelope-from bugzilla-noreply@freebsd.org)
Received: from bugs.freebsd.org ([127.0.1.118])
 by kenobi.freebsd.org (8.15.2/8.15.2) with ESMTP id tAAKAoYO097941
 for <freebsd-doc@FreeBSD.org>; Tue, 10 Nov 2015 20:10:50 GMT
 (envelope-from bugzilla-noreply@freebsd.org)
From: bugzilla-noreply@freebsd.org
To: freebsd-doc@FreeBSD.org
Subject: [Bug 204449] UUID(3) man page page lacks return value information
Date: Tue, 10 Nov 2015 20:10:50 +0000
X-Bugzilla-Reason: AssignedTo
X-Bugzilla-Type: new
X-Bugzilla-Watch-Reason: None
X-Bugzilla-Product: Documentation
X-Bugzilla-Component: Documentation
X-Bugzilla-Version: Latest
X-Bugzilla-Keywords: 
X-Bugzilla-Severity: Affects Only Me
X-Bugzilla-Who: michael.cress@cress.us
X-Bugzilla-Status: New
X-Bugzilla-Priority: ---
X-Bugzilla-Assigned-To: freebsd-doc@FreeBSD.org
X-Bugzilla-Target-Milestone: ---
X-Bugzilla-Flags: 
X-Bugzilla-Changed-Fields: bug_id short_desc product version rep_platform
 op_sys bug_status bug_severity priority component assigned_to reporter
Message-ID: <bug-204449-9@https.bugs.freebsd.org/bugzilla/>
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: 7bit
X-Bugzilla-URL: https://bugs.freebsd.org/bugzilla/
Auto-Submitted: auto-generated
MIME-Version: 1.0
X-BeenThere: freebsd-doc@freebsd.org
X-Mailman-Version: 2.1.20
Precedence: list
List-Id: Documentation project <freebsd-doc.freebsd.org>
List-Unsubscribe: <https://lists.freebsd.org/mailman/options/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=unsubscribe>
List-Archive: <http://lists.freebsd.org/pipermail/freebsd-doc/>
List-Post: <mailto:freebsd-doc@freebsd.org>
List-Help: <mailto:freebsd-doc-request@freebsd.org?subject=help>
List-Subscribe: <https://lists.freebsd.org/mailman/listinfo/freebsd-doc>,
 <mailto:freebsd-doc-request@freebsd.org?subject=subscribe>
X-List-Received-Date: Tue, 10 Nov 2015 20:10:50 -0000

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@FreeBSD.org
          Reporter: michael.cress@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.