[PATCH man-pages v2 0/6] userfaultfd: document read-write-protect mode

This series documents userfaultfd read-write-protection tracking
(UFFDIO_REGISTER_MODE_RWP), a working-set tracking mechanism for VM
guest memory landing in Linux 7.2.

v1: https://lore.kernel.org/all/[email protected]/

The matching kernel series ("userfaultfd: working set tracking for
VM guest memory") v5 is at:
  https://lore.kernel.org/all/[email protected]/

== Changes since v1 ==

Addresses Alejandro Colomar's review:

  - \(em -> \[em] with parenthesis-style spacing.
  - Semantic newlines.
  - "user space" two words; "By default,".
  - "returns EINVAL" -> "fails with EINVAL".
  - "read-write-protect mode" hyphenation (1/6 subject too).
  - .PP -> .P; awkward .RB MADV_DONTNEED line -> colon-list;
    one identifier per .RB line in HISTORY.

mandoc -Tlint clean on all six files. Mike Rapoport's Acked-by
from v1 picked up.

== New UAPI documented ==

  UFFDIO_REGISTER_MODE_RWP    registration-mode bit (UFFDIO_REGISTER.2const)
  UFFD_FEATURE_RWP            capability bit          (UFFDIO_API.2const)
  UFFD_FEATURE_RWP_ASYNC      async resolution        (UFFDIO_API.2const)
  UFFDIO_RWPROTECT            install/remove RWP      (new page)
  UFFDIO_SET_MODE             runtime mode toggle     (new page)
  UFFD_PAGEFAULT_FLAG_RWP     new pagefault.flags bit (userfaultfd.2)
  PAGE_IS_ACCESSED            PAGEMAP_SCAN bit        (kernel docs only)

== Series layout ==

  1. userfaultfd.2: overview, registration mode entry, new pagefault
     flag, VERSIONS line, and an "Userfaultfd read-write-protect
     mode" section.
  2-3. New UFFDIO_RWPROTECT.2const and UFFDIO_SET_MODE.2const pages.
  4. UFFDIO_API.2const: UFFD_FEATURE_RWP, UFFD_FEATURE_RWP_ASYNC,
     and 1 << _UFFDIO_SET_MODE.
  5. UFFDIO_REGISTER.2const: UFFDIO_REGISTER_MODE_RWP and
     1 << _UFFDIO_RWPROTECT.
  6. ioctl_userfaultfd.2: reference the two new ioctls.

Order: new pages first so the cross-references in patches 4-6 link
to pages that already exist.

Kiryl Shutsemau (5):
  UFFDIO_RWPROTECT.2const: New page
  UFFDIO_SET_MODE.2const: New page
  UFFDIO_API.2const: Document UFFD_FEATURE_RWP{,_ASYNC} and 1 <<
    _UFFDIO_SET_MODE
  UFFDIO_REGISTER.2const: Document UFFDIO_REGISTER_MODE_RWP and 1 <<
    _UFFDIO_RWPROTECT
  ioctl_userfaultfd.2: Reference UFFDIO_RWPROTECT and UFFDIO_SET_MODE

Kiryl Shutsemau (Meta) (1):
  userfaultfd.2: Add read-write-protect mode

 man/man2/ioctl_userfaultfd.2          |   4 +
 man/man2/userfaultfd.2                | 174 +++++++++++++++++++++++++-
 man/man2const/UFFDIO_API.2const       |  31 +++++
 man/man2const/UFFDIO_REGISTER.2const  |  24 ++++
 man/man2const/UFFDIO_RWPROTECT.2const | 122 ++++++++++++++++++
 man/man2const/UFFDIO_SET_MODE.2const  |  98 +++++++++++++++
 6 files changed, 449 insertions(+), 4 deletions(-)
 create mode 100644 man/man2const/UFFDIO_RWPROTECT.2const
 create mode 100644 man/man2const/UFFDIO_SET_MODE.2const


base-commit: 9a4bfd0e50745c2649b6291db40b58e37c9c1c6b
-- 
2.54.0