[v5,0/4] man2: udpate mm/userfaultfd manpages to latest

Message

Peter Xu March 29, 2021, 10:18 p.m. UTC

v5:
- add r-bs for Mike R.
- Fix spelling mistake "diable" [Mike R.]
- s/Starting from/Since/ for patch 2 (also replaced two existing ones in the
  same file) [Alex]
- s/un-write-protect/write-unprotect/ [Alex]
- s/The process was interrupted and need to retry/The process was interrupted;
  retry this call/ in the last patch. [Alex]

v4:
- Fixed a few "subordinate clauses" (SC) cases [Alex]
- Reword in ioctl_userfaultfd.2 to use bold font for the two modes referenced,
  so as to be clear on what is "both" referring to [Alex]

v3:
- Don't use "Currently", instead add "(since x.y)" mark where proper [Alex]
- Always use semantic newlines across the whole patchset [Alex]
- Use quote when possible, rather than escapes [Alex]
- Fix one missing replacement of ".BR" -> ".B" [Alex]
- Some other trivial rephrases here and there when fixing up above

v2 changes:
- Fix wordings as suggested [MikeR]
- convert ".BR" to ".B" where proper for the patchset [Alex]
- rearrange a few lines in the last two patches where they got messed up
- document more things, e.g. UFFDIO_COPY_MODE_WP; and also on how to resolve a
  wr-protect page fault.

There're two features missing in current manpage, namely:

  (1) Userfaultfd Thread-ID feature
  (2) Userfaultfd write protect mode

There's also a 3rd one which was just contributed from Axel - Axel, I think it
would be great if you can add that part too, probably after the whole
hugetlbfs/shmem minor mode reaches the linux master branch.

Please review, thanks.

Peter Xu (4):
  userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs
  userfaultfd.2: Add write-protect mode
  ioctl_userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs
  ioctl_userfaultfd.2: Add write-protect mode docs

 man2/ioctl_userfaultfd.2 |  89 +++++++++++++++++++++++++++-
 man2/userfaultfd.2       | 121 +++++++++++++++++++++++++++++++++++++--
 2 files changed, 203 insertions(+), 7 deletions(-)

Comments

Alejandro Colomar April 1, 2021, noon UTC | #1

Hi Peter,

On 3/30/21 12:18 AM, Peter Xu wrote:
> v5:
> - add r-bs for Mike R.
> - Fix spelling mistake "diable" [Mike R.]
> - s/Starting from/Since/ for patch 2 (also replaced two existing ones in the
>    same file) [Alex]
> - s/un-write-protect/write-unprotect/ [Alex]
> - s/The process was interrupted and need to retry/The process was interrupted;
>    retry this call/ in the last patch. [Alex]
> 
> v4:
> - Fixed a few "subordinate clauses" (SC) cases [Alex]
> - Reword in ioctl_userfaultfd.2 to use bold font for the two modes referenced,
>    so as to be clear on what is "both" referring to [Alex]
> 
> v3:
> - Don't use "Currently", instead add "(since x.y)" mark where proper [Alex]
> - Always use semantic newlines across the whole patchset [Alex]
> - Use quote when possible, rather than escapes [Alex]
> - Fix one missing replacement of ".BR" -> ".B" [Alex]
> - Some other trivial rephrases here and there when fixing up above
> 
> v2 changes:
> - Fix wordings as suggested [MikeR]
> - convert ".BR" to ".B" where proper for the patchset [Alex]
> - rearrange a few lines in the last two patches where they got messed up
> - document more things, e.g. UFFDIO_COPY_MODE_WP; and also on how to resolve a
>    wr-protect page fault.
> 
> There're two features missing in current manpage, namely:
> 
>    (1) Userfaultfd Thread-ID feature
>    (2) Userfaultfd write protect mode
> 
> There's also a 3rd one which was just contributed from Axel - Axel, I think it
> would be great if you can add that part too, probably after the whole
> hugetlbfs/shmem minor mode reaches the linux master branch.
> 
> Please review, thanks.
> 
> Peter Xu (4):
>    userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs
>    userfaultfd.2: Add write-protect mode
>    ioctl_userfaultfd.2: Add UFFD_FEATURE_THREAD_ID docs
>    ioctl_userfaultfd.2: Add write-protect mode docs

I applied all 4 patches (with a few minor fixes to 1/4 and 4/4 (cosmetic 
fixes; some of them about the 80-col right margin)): 
<https://github.com/alejandro-colomar/man-pages/tree/eb8f2001d493d458d08b9b87605ed2ac453c7f5f>

Thanks!

Alex

> 
>   man2/ioctl_userfaultfd.2 |  89 +++++++++++++++++++++++++++-
>   man2/userfaultfd.2       | 121 +++++++++++++++++++++++++++++++++++++--
>   2 files changed, 203 insertions(+), 7 deletions(-)
>

Michael Kerrisk (man-pages) April 5, 2021, 11:50 a.m. UTC | #2

Hi Alex,

> I applied all 4 patches (with a few minor fixes to 1/4 and 4/4 (cosmetic 
> fixes; some of them about the 80-col right margin)): 
> <https://github.com/alejandro-colomar/man-pages/tree/eb8f2001d493d458d08b9b87605ed2ac453c7f5f>

How big is your current queue of pending patches from others?

Thanks,

Michael