NetBSD Problem Report #53608

From www@NetBSD.org  Fri Sep 14 19:02:05 2018
Return-Path: <www@NetBSD.org>
Received: from mail.netbsd.org (mail.netbsd.org [199.233.217.200])
	(using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits))
	(Client CN "mail.NetBSD.org", Issuer "mail.NetBSD.org CA" (not verified))
	by mollari.NetBSD.org (Postfix) with ESMTPS id 526597A1D0
	for <gnats-bugs@gnats.NetBSD.org>; Fri, 14 Sep 2018 19:02:05 +0000 (UTC)
Message-Id: <20180914190204.082657A225@mollari.NetBSD.org>
Date: Fri, 14 Sep 2018 19:02:04 +0000 (UTC)
From: ianbruene@gmail.com
Reply-To: ianbruene@gmail.com
To: gnats-bugs@NetBSD.org
Subject: Patch for missing attribute(3) documentation
X-Send-Pr-Version: www-1.0

>Number:         53608
>Category:       toolchain
>Synopsis:       Patch for missing attribute(3) documentation
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    toolchain-manager
>State:          closed
>Class:          doc-bug
>Submitter-Id:   net
>Arrival-Date:   Fri Sep 14 19:05:00 +0000 2018
>Closed-Date:    Sat Sep 15 00:03:14 +0000 2018
>Last-Modified:  Sat Sep 15 00:03:14 +0000 2018
>Originator:     Ian Bruene
>Release:        netbsd-8.0
>Organization:
Internet Civil Engineering Institute
>Environment:
Linux Durandal 4.15.0-34-generic #37-Ubuntu SMP Mon Aug 27 15:21:48 UTC 2018 x86_64 x86_64 x86_64 GNU/Linux

>Description:
The attribute(3) manpage does not document the existence of the __printflike or __sysloglike attributes.

>How-To-Repeat:
Open a terminal and type "man 3 attribute". Alternatively run "man -l <path-to-source-tree>/share/man/man3/attribute.3".

>Fix:
--- /home/ian/Documents/netbsd-src/src/share/man/man3/attribute.3	2018-09-14 13:48:52.571162571 -0500
+++ "/home/ian/Documents/netbsd-src/src/share/man/man3/attribute (orig).3"	2014-04-21 10:52:27.000000000 -0500
@@ -64,10 +64,6 @@
 .Fn __predict_true "exp"
 .Pp
 .Fn __predict_false "exp"
-.Pp
-.Fn __printflike "fmtarg" "firstvararg"
-.Pp
-.Fn __sysloglike "fmtarg" "firstvararg"
 .Sh DESCRIPTION
 As an extension to the C standard, some compilers allow non-standard
 attributes to be associated with functions, variables, or types, to
@@ -360,19 +356,6 @@
 .Ic __predict_false
 and
 .Ic __predict_true .
-.It Fn __printflike "fmtarg" "firstvararg"
-Marks a function as taking printf-like arguments.
-.Fa fmtarg
-is the index of the format string in the argument list, and
-.Fa firstvararg
-is the index of the first item of the vararg list.
-.It Fn __sysloglike "fmtarg" "firstvararg"
-Marks a function as taking syslog-like arguments.
-Allows use of the %m formatting code.
-.Fa fmtarg
-is the index of the format string in the argument list, and
-.Fa firstvararg
-is the index of the first item of the vararg list.
 .El
 .Sh SEE ALSO
 .Xr clang 1 ,

>Release-Note:

>Audit-Trail:
From: "Christos Zoulas" <christos@netbsd.org>
To: gnats-bugs@gnats.NetBSD.org
Cc: 
Subject: PR/53608 CVS commit: src/share/man/man3
Date: Fri, 14 Sep 2018 16:53:49 -0400

 Module Name:	src
 Committed By:	christos
 Date:		Fri Sep 14 20:53:49 UTC 2018

 Modified Files:
 	src/share/man/man3: attribute.3

 Log Message:
 PR/53608: Ian Bruene: document __{printf,syslog}like.


 To generate a diff of this commit:
 cvs rdiff -u -r1.17 -r1.18 src/share/man/man3/attribute.3

 Please note that diffs are not public domain; they are subject to the
 copyright notices on the relevant files.

State-Changed-From-To: open->closed
State-Changed-By: maya@NetBSD.org
State-Changed-When: Sat, 15 Sep 2018 00:03:14 +0000
State-Changed-Why:
committed. thanks for the patch!


>Unformatted:

Home	PR Database Search