linux-man.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Michael Kerrisk <mtk.manpages-Re5JQEeQqe8AvxtiuMwx3w@public.gmane.org>
To: "fkater-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org"
	<fkater-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org>
Cc: linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
Subject: Re: readdir_r: return values not clearly mentioned
Date: Fri, 10 Sep 2010 07:50:32 +0200	[thread overview]
Message-ID: <AANLkTimQ1Ed8_d3ed=1aMfpddsKGQDVwa7tu0WS_onLb@mail.gmail.com> (raw)
In-Reply-To: <20100722072614.GA6355@comppasch2>

On Thu, Jul 22, 2010 at 9:26 AM, fkater-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org
<fkater-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org> wrote:
> Hi,
>
> in man 3 readdir_r (man-pages-3.24, page date 2009-07-04)
> the possible return values are described as:
>
> "The readdir_r() function returns 0 on success.  On error,
> it returns a positive error number."
>
> It is not mentioned which possible error numbers may occur.

Well, it is, but it could be clearer. See the patch below, for man-pages-3.27.

Thanks,

Michael

--- a/man3/readdir.3
+++ b/man3/readdir.3
@@ -31,7 +31,7 @@
 .\"     Rework discussion of nonstandard structure fields.
 .\" 2008-09-11, mtk, Document readdir_r().
 .\"
-.TH READDIR 3  2009-07-04 "" "Linux Programmer's Manual"
+.TH READDIR 3  2010-09-10 "" "Linux Programmer's Manual"
 .SH NAME
 readdir, readdir_r \- read a directory
 .SH SYNOPSIS
@@ -131,7 +131,7 @@ is set appropriately.
 The
 .BR readdir_r ()
 function returns 0 on success.
-On error, it returns a positive error number.
+On error, it returns a positive error number (listed under ERRORS).
 If the end of the directory stream is reached,
 .BR readdir_r ()
 returns 0, and returns NULL in



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo-u79uwXL29TY76Z2rM5mHXA@public.gmane.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html

      reply	other threads:[~2010-09-10  5:50 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2010-07-22  7:26 readdir_r: return values not clearly mentioned fkater-gM/Ye1E23mwN+BqQ9rBEUg
2010-09-10  5:50 ` Michael Kerrisk [this message]

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='AANLkTimQ1Ed8_d3ed=1aMfpddsKGQDVwa7tu0WS_onLb@mail.gmail.com' \
    --to=mtk.manpages-re5jqeeqqe8avxtiumwx3w@public.gmane.org \
    --cc=fkater-gM/Ye1E23mwN+BqQ9rBEUg@public.gmane.org \
    --cc=linux-man-u79uwXL29TY76Z2rM5mHXA@public.gmane.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;
as well as URLs for NNTP newsgroup(s).