public inbox for linux-man@vger.kernel.org
 help / color / mirror / Atom feed
From: bugzilla-daemon@kernel.org
To: linux-man@vger.kernel.org
Subject: [Bug 216461] New: Misleading synposis in printf(3) for vsnprintf(3)
Date: Thu, 08 Sep 2022 01:42:59 +0000	[thread overview]
Message-ID: <bug-216461-11311@https.bugzilla.kernel.org/> (raw)

https://bugzilla.kernel.org/show_bug.cgi?id=216461

            Bug ID: 216461
           Summary: Misleading synposis in printf(3) for vsnprintf(3)
           Product: Documentation
           Version: unspecified
          Hardware: All
                OS: Linux
            Status: NEW
          Severity: normal
          Priority: P1
         Component: man-pages
          Assignee: documentation_man-pages@kernel-bugs.osdl.org
          Reporter: sam@gentoo.org
        Regression: No

Hi!

The printf(3) page says:
```
SYNOPSIS
       #include <stdio.h>

       int printf(const char *restrict format, ...);
[...]

       #include <stdarg.h>

       int vprintf(const char *restrict format, va_list ap);
[...]
       int vsnprintf(char *restrict str, size_t size,
                   const char *restrict format, va_list ap);
```

It might just be me, but the gap between the two blocks of functions made me
think that only <stdarg.h> was needed for those latter functions, even though
it's needed for va_list.

Would it be appropriate to add a second #include <stdio.h> above #include
<stdarg.h> to resolve the ambiguity?

Thanks!

-- 
You may reply to this email to add a comment.

You are receiving this mail because:
You are watching the assignee of the bug.

                 reply	other threads:[~2022-09-08  1:43 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=bug-216461-11311@https.bugzilla.kernel.org/ \
    --to=bugzilla-daemon@kernel.org \
    --cc=linux-man@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox