Linux Manual Pages development
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx+linux-man@kernel.org>
To: Jorge Almeida <jjalmeida@gmail.com>
Cc: linux-man@vger.kernel.org
Subject: Re: [bug report] opendir(3): document file offset behavior for fdopendir()
Date: Wed, 18 Nov 2026 12:21:12 +0100	[thread overview]
Message-ID: <av2JnhGHAaSed-VU@devuan> (raw)
In-Reply-To: <CAKpSnpJtcEf-RT+4yf=t3KtdYDWD3hfKqM51Di26ay7JHSj5MQ@mail.gmail.com>

[-- Attachment #1: Type: text/plain, Size: 2888 bytes --]

Hi Jorge,

[Please keep the mailing list in CC]

> Date: 2026-11-18 10:16:51+0000
> From: Jorge Almeida <jjalmeida@gmail.com>
>
> On Wed, 18 Nov 2026 at 00:45, Alejandro Colomar
> <alx+linux-man@kernel.org> wrote:
> >
> 
> 
> >
> >         commit 7b4329e4945b1506f75c67c18730ad0191e09fb0
> >         Author: Alejandro Colomar <alx@kernel.org>
> >         Date:   2026-11-18 01:38:13 +0100
> >
> >             man/man3/opendir.3: fdopendir(): Use wording mirroring that of fdopen(3)
> >
> >             The old documentation didn't clarify whether the position indicator was
> >             reset or was that of the existing file descriptor.  Let's use wording
> >             mirroring fdopen(3), which already made this clear.  This makes the
> >             pages more consistent.
> >
> >             Reported-by: Jorge Almeida <jjalmeida@gmail.com>
> >             Message-ID: <CAKpSnp+XojktUF=UL81JZ2bFyBSxXHneFSBsiPi2BMg043xa3g@mail.gmail.com>
> >             Signed-off-by: Alejandro Colomar <alx@kernel.org>
> >
> >         diff --git a/man/man3/opendir.3 b/man/man3/opendir.3
> >         index 443ea8f3dd0a..8184844893b9 100644
> >         --- a/man/man3/opendir.3
> >         +++ b/man/man3/opendir.3
> >         @@ -43,16 +43,16 @@ .SH DESCRIPTION
> >          The
> >          .BR fdopendir ()
> >          function
> >         -is like
> >         -.BR opendir (),
> >         -but returns a directory stream for the directory referred
> >         -to by the open file descriptor
> >         +associates a directory stream
> >         +with the existing directory file descriptor,
> >          .IR fd .
> >         -After a successful call to
> >         -.BR fdopendir (),
> >         -.I fd
> >         -is used internally by the implementation,
> >         -and should not otherwise be used by the application.
> >         +The stream position indicator of the new directory stream
> >         +is set to that belonging to
> >         +.IR fd .
> >         +The file descriptor is not dup'ed,
> >         +and will be closed when the directory stream created by
> >         +.BR fdopendir ()
> >         +is closed.
> >          .SH RETURN VALUE
> >          The
> >          .BR opendir ()
> >
> > Let me know if you'd apply any changes after this patch.
> >
> >
> > Cheers,
> > Alex
> >
> 
> Clear enough.

Thanks!

> However, "with the existing directory file descriptor"
> misses the "open". I believe O_PATH is not enough!

Indeed, I was also concerned that we were removing that.  But fdopen(3)
didn't say "open", so I copied it from there.  Now we should add "open"
to both pages.

Would you mind sending a patch?  Even without being comfortable with
man(7), it should be trivial.  :)


Have a lovely day!
Alex

> 
> Cheers
> 
> Jorge

-- 
<https://www.alejandro-colomar.es>

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

      parent reply	other threads:[~2026-11-18 11:21 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-13 21:28 [bug report] opendir(3): document file offset behavior for fdopendir() Jorge Almeida
2026-11-13 21:39 ` Alejandro Colomar
2026-11-18  0:45   ` Alejandro Colomar
     [not found]     ` <CAKpSnpJtcEf-RT+4yf=t3KtdYDWD3hfKqM51Di26ay7JHSj5MQ@mail.gmail.com>
2026-11-18 11:21       ` Alejandro Colomar [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=av2JnhGHAaSed-VU@devuan \
    --to=alx+linux-man@kernel.org \
    --cc=jjalmeida@gmail.com \
    --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