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

Message

Peter Xu March 4, 2021, 4:31 p.m. UTC

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 |  81 ++++++++++++++++++++++++++--
 man2/userfaultfd.2       | 111 ++++++++++++++++++++++++++++++++++++++-
 2 files changed, 187 insertions(+), 5 deletions(-)

Comments

Axel Rasmussen March 4, 2021, 5:54 p.m. UTC | #1

On Thu, Mar 4, 2021 at 8:31 AM Peter Xu <[e-mail]> wrote:
>
> 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.

Ack, this is on my list of "todos". Agree it makes sense to wait until
the code is in Linus' tree, then I'll send a patch for the man pages.

>
> 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 |  81 ++++++++++++++++++++++++++--
>  man2/userfaultfd.2       | 111 ++++++++++++++++++++++++++++++++++++++-
>  2 files changed, 187 insertions(+), 5 deletions(-)
>
> --
> 2.26.2
>
>