Linux Manual Pages development
 help / color / mirror / Atom feed
From: Alejandro Colomar <alx@kernel.org>
To: Dorjoy Chowdhury <dorjoychy111@gmail.com>
Cc: linux-man@vger.kernel.org, brauner@kernel.org, jlayton@kernel.org
Subject: Re: [PATCH 1/1] man/man2/openat2.2: Document OPENAT2_REGULAR flag
Date: Sat, 25 Apr 2026 16:58:11 +0200	[thread overview]
Message-ID: <aezULCZu3eZhdUaq@devuan> (raw)
In-Reply-To: <20260425134048.62616-2-dorjoychy111@gmail.com>

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

Hi Dorjoy,

On 2026-04-25T19:39:28+0600, Dorjoy Chowdhury wrote:
> Signed-off-by: Dorjoy Chowdhury <dorjoychy111@gmail.com>
> ---
>  man/man2/openat2.2 | 19 +++++++++++++++++++
>  1 file changed, 19 insertions(+)
> 
> diff --git a/man/man2/openat2.2 b/man/man2/openat2.2
> index f0770f3a0..42ebf22ea 100644
> --- a/man/man2/openat2.2
> +++ b/man/man2/openat2.2
> @@ -133,6 +133,19 @@ argument,
>  .BR openat2 ()
>  returns an error if unknown or conflicting flags are specified in
>  .IR how.flags .
> +.IP
> +.BR openat2 ()
> +also supports the below additional flags:
> +.RS
> +.TP
> +.BR OPENAT2_REGULAR " (since Linux 7.2)"
> +Only open the file specified by
> +.I path
> +if it is a regular file. If it is not a regular file,

Please use semantic newlines.  See man-pages(7):

$ MANWIDTH=72 man man-pages | awk '/Use semantic newlines/,/^$/'
   Use semantic newlines
     In the source of a manual page, new sentences should be started on
     new lines, long sentences should be split  into  lines  at  clause
     breaks  (commas,  semicolons, colons, and so on), and long clauses
     should be split at phrase boundaries.  This convention,  sometimes
     known as "semantic newlines", makes it easier to see the effect of
     patches, which often operate at the level of individual sentences,
     clauses, or phrases.

That is, break the line after period.

> +.BR openat2 ()
> +fails with the error
> +.BR EFTYPE .

Hmmm, this error code is new to me.

	alx@devuan:~$ errno EFTYPE
	alx@devuan:~$ echo $?
	1
	alx@devuan:~$ man 3 errno | grep EFTYPE
	alx@devuan:~$ grepc EFTYPE /usr/include/
	alx@devuan:~$ 

I don't see it documented, nor defined under </usr/include>.
Is this error code available in user space?
Is it a new error code?

> +.RE
>  .TP
>  .I mode
>  This field specifies the
> @@ -471,6 +484,12 @@ and an escape from the root during path resolution was detected.
>  contains
>  .BR RESOLVE_NO_XDEV ,
>  and a path component crosses a mount point.
> +.TP
> +.B EFTYPE
> +.I how.flags
> +contains
> +.BR OPENAT2_REGULAR

This should use B instead of BR.  BR is for alternating Bold and Roman.
B is for Bold.

Other than these minor formatting issues, and the question about EFTYPE,
the patch looks good to me.  Thanks!


Have a lovely day!
Alex

> +flag and the path is not a regular file.
>  .SH STANDARDS
>  Linux.
>  .SH HISTORY
> -- 
> 2.53.0
> 

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

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

  reply	other threads:[~2026-04-25 14:58 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-04-25 13:39 [PATCH 0/1] OPENAT2_REGULAR flag documentation Dorjoy Chowdhury
2026-04-25 13:39 ` [PATCH 1/1] man/man2/openat2.2: Document OPENAT2_REGULAR flag Dorjoy Chowdhury
2026-04-25 14:58   ` Alejandro Colomar [this message]
2026-04-25 15:07     ` Dorjoy Chowdhury
2026-04-25 17:39       ` Alejandro Colomar

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=aezULCZu3eZhdUaq@devuan \
    --to=alx@kernel.org \
    --cc=brauner@kernel.org \
    --cc=dorjoychy111@gmail.com \
    --cc=jlayton@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