Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.37 as permitted sender) client-ip=23.128.96.37;
Date:   Tue, 17 Oct 2023 16:01:07 -0700
Mime-Version: 1.0
Message-ID: <20231017230110.3170850-1-axelrasmussen@google.com>
Subject: [PATCH v3 0/3] userfaultfd man page updates
From:   Axel Rasmussen <axelrasmussen@google.com>
To:     Alejandro Colomar <alx@kernel.org>,
        Mike Rapoport <rppt@kernel.org>, Peter Xu <peterx@redhat.com>
Cc:     linux-man@vger.kernel.org, linux-mm@kvack.org,
        linux-kernel@vger.kernel.org,
        Axel Rasmussen <axelrasmussen@google.com>
Content-Type: text/plain; charset="UTF-8"
Precedence: bulk

This series includes only the remaining patches not applied from v1/v2,
with review comments addressed. This series is based on the "contrib"
branch [1].

Changelog:

v2->v3:
 - Rebased onto updated contrib branch.
 - In patch 2 (patch 4 in v2), reordered error codes in alphabetical order,
   and fixed extra spacing in the EINVAL error description.
 - In patch 3, fix mistakenly copy-pasted "struct uffdio_continue" (should
   have been "struct uffdio_poison"), and alphabetically order
   UFFDIO_CONTINUE error codes.

v1->v2:
 - In patch 1 (patch 5 in v1), change "after" to "since" for consistency
   and to be clear that we mean 4.11+ (inclusive).
 - In patch 2 (patch 7 in v1), reorder error codes alphabetically (EINVAL
   then EPERM).
 - In patch 3 (patch 8 in v1), resolve conflicts with earlier review
   comments.

Original cover letter:

Various updates for userfaultfd man pages. To summarize the changes:

- Correctly / fully describe the two-step feature support handshake
  process.
- Describe new UFFDIO_POISON ioctl.
- Other small improvements (missing ioctls, error codes, etc).

[1]: https://www.alejandro-colomar.es/src/alx/linux/man-pages/man-pages.git/log/?h=contrib

Axel Rasmussen (3):
  ioctl_userfaultfd.2: clarify the state of the uffdio_api structure on
    error
  ioctl_userfaultfd.2: fix / update UFFDIO_REGISTER error code list
  ioctl_userfaultfd.2: document new UFFDIO_POISON ioctl

 man2/ioctl_userfaultfd.2 | 173 ++++++++++++++++++++++++++++++++-------
 1 file changed, 145 insertions(+), 28 deletions(-)

--
2.42.0.655.g421f12c284-goog