[v5,0/3] man2: Document RWF_ATOMIC

Message

John Garry July 22, 2024, 9:57 a.m. UTC

Document RWF_ATOMIC flag for pwritev2().

RWF_ATOMIC is used for enabling torn-write protection.

We use RWF_ATOMIC as this is legacy name for similar feature proposed in
the past.

Kernel support has now been merged into Linus' tree, to be released in
v6.11

Differences to v4:
- Add RB tags from Darrick (thanks)
- Revise description for readv.2 (Darrick)
- Re-order RWF_ATOMIC in readv.2

Differences to v3:
- Formatting changes (Alex)
 - semantic newlines
 - Add missing .TP in statx
 - Combine description of atomic write unit min and max
 - misc others

Himanshu Madhani (2):
  statx.2: Document STATX_WRITE_ATOMIC
  readv.2: Document RWF_ATOMIC flag

John Garry (1):
  io_submit.2: Document RWF_ATOMIC

 man/man2/io_submit.2 | 19 ++++++++++++++
 man/man2/readv.2     | 61 ++++++++++++++++++++++++++++++++++++++++++++
 man/man2/statx.2     | 27 ++++++++++++++++++++
 3 files changed, 107 insertions(+)

Comments

Alejandro Colomar July 31, 2024, 10:20 a.m. UTC | #1

Hi John, Darrick,

On Mon, Jul 22, 2024 at 09:57:20AM GMT, John Garry wrote:
> Document RWF_ATOMIC flag for pwritev2().
> 
> RWF_ATOMIC is used for enabling torn-write protection.
> 
> We use RWF_ATOMIC as this is legacy name for similar feature proposed in
> the past.
> 
> Kernel support has now been merged into Linus' tree, to be released in
> v6.11
> 
> Differences to v4:
> - Add RB tags from Darrick (thanks)
> - Revise description for readv.2 (Darrick)
> - Re-order RWF_ATOMIC in readv.2
> 
> Differences to v3:
> - Formatting changes (Alex)
>  - semantic newlines
>  - Add missing .TP in statx
>  - Combine description of atomic write unit min and max
>  - misc others
> 
> Himanshu Madhani (2):
>   statx.2: Document STATX_WRITE_ATOMIC
>   readv.2: Document RWF_ATOMIC flag
> 
> John Garry (1):
>   io_submit.2: Document RWF_ATOMIC

I've applied the 3 patches, with Darrick's RB extra tag, and some
formatting fixes from myself.  Thanks for the patches!

Have a lovely day!
Alex

> 
>  man/man2/io_submit.2 | 19 ++++++++++++++
>  man/man2/readv.2     | 61 ++++++++++++++++++++++++++++++++++++++++++++
>  man/man2/statx.2     | 27 ++++++++++++++++++++
>  3 files changed, 107 insertions(+)
> 
> -- 
> 2.31.1
>