diff mbox series

[v3,3/3] io_submit.2: Document RWF_ATOMIC

Message ID 20240708114227.211195-4-john.g.garry@oracle.com (mailing list archive)
State New
Headers show
Series man2: Document RWF_ATOMIC | expand

Commit Message

John Garry July 8, 2024, 11:42 a.m. UTC
Document RWF_ATOMIC for asynchronous I/O.

Signed-off-by: John Garry <john.g.garry@oracle.com>
---
 man/man2/io_submit.2 | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

Comments

Alejandro Colomar July 9, 2024, 4:52 p.m. UTC | #1
On Mon, Jul 08, 2024 at 11:42:27AM GMT, John Garry wrote:
> Document RWF_ATOMIC for asynchronous I/O.
> 
> Signed-off-by: John Garry <john.g.garry@oracle.com>
> ---
>  man/man2/io_submit.2 | 17 +++++++++++++++++
>  1 file changed, 17 insertions(+)
> 
> diff --git a/man/man2/io_submit.2 b/man/man2/io_submit.2
> index c53ae9aaf..ef6414d24 100644
> --- a/man/man2/io_submit.2
> +++ b/man/man2/io_submit.2
> @@ -140,6 +140,23 @@ as well the description of
>  .B O_SYNC
>  in
>  .BR open (2).
> +.TP
> +.BR RWF_ATOMIC " (since Linux 6.11)"
> +Write a block of data such that a write will never be
> +torn from power fail or similar. See the description
> +of the flag of the same name in

Maybe?:

of this same flag in

> +.BR pwritev2 (2).
> +For usage with
> +.BR IOCB_CMD_PWRITEV,
> +the upper vector limit is in
> +.I stx_atomic_write_segments_max.
> +See
> +.B STATX_WRITE_ATOMIC
> +and
> +.I stx_atomic_write_segments_max
> +description
> +in
> +.BR statx (2).
>  .RE
>  .TP
>  .I aio_lio_opcode
> -- 
> 2.31.1
>
Alejandro Colomar July 9, 2024, 4:53 p.m. UTC | #2
On Tue, Jul 09, 2024 at 06:53:03PM GMT, Alejandro Colomar wrote:
> On Mon, Jul 08, 2024 at 11:42:27AM GMT, John Garry wrote:
> > Document RWF_ATOMIC for asynchronous I/O.
> > 
> > Signed-off-by: John Garry <john.g.garry@oracle.com>
> > ---
> >  man/man2/io_submit.2 | 17 +++++++++++++++++
> >  1 file changed, 17 insertions(+)
> > 
> > diff --git a/man/man2/io_submit.2 b/man/man2/io_submit.2
> > index c53ae9aaf..ef6414d24 100644
> > --- a/man/man2/io_submit.2
> > +++ b/man/man2/io_submit.2
> > @@ -140,6 +140,23 @@ as well the description of
> >  .B O_SYNC
> >  in
> >  .BR open (2).
> > +.TP
> > +.BR RWF_ATOMIC " (since Linux 6.11)"
> > +Write a block of data such that a write will never be
> > +torn from power fail or similar. See the description
> > +of the flag of the same name in
> 
> Maybe?:
> 
> of this same flag in

Or just to be less ambiguous:

See the description of
.B RWF_ATOMIC
in

> 
> > +.BR pwritev2 (2).
> > +For usage with
> > +.BR IOCB_CMD_PWRITEV,
> > +the upper vector limit is in
> > +.I stx_atomic_write_segments_max.
> > +See
> > +.B STATX_WRITE_ATOMIC
> > +and
> > +.I stx_atomic_write_segments_max
> > +description
> > +in
> > +.BR statx (2).
> >  .RE
> >  .TP
> >  .I aio_lio_opcode
> > -- 
> > 2.31.1
> > 
> 
> -- 
> <https://www.alejandro-colomar.es/>
John Garry July 10, 2024, 10:13 a.m. UTC | #3
On 09/07/2024 17:53, Alejandro Colomar wrote:
>>> +.BR RWF_ATOMIC " (since Linux 6.11)"
>>> +Write a block of data such that a write will never be
>>> +torn from power fail or similar. See the description
>>> +of the flag of the same name in
>> Maybe?:
>>
>> of this same flag in
> Or just to be less ambiguous:
> 
> See the description of
> .B RWF_ATOMIC
> in


ok, that seems better.

Thanks,
John
diff mbox series

Patch

diff --git a/man/man2/io_submit.2 b/man/man2/io_submit.2
index c53ae9aaf..ef6414d24 100644
--- a/man/man2/io_submit.2
+++ b/man/man2/io_submit.2
@@ -140,6 +140,23 @@  as well the description of
 .B O_SYNC
 in
 .BR open (2).
+.TP
+.BR RWF_ATOMIC " (since Linux 6.11)"
+Write a block of data such that a write will never be
+torn from power fail or similar. See the description
+of the flag of the same name in
+.BR pwritev2 (2).
+For usage with
+.BR IOCB_CMD_PWRITEV,
+the upper vector limit is in
+.I stx_atomic_write_segments_max.
+See
+.B STATX_WRITE_ATOMIC
+and
+.I stx_atomic_write_segments_max
+description
+in
+.BR statx (2).
 .RE
 .TP
 .I aio_lio_opcode