[PATCH 04/10] ioctl_userfaultfd.2: fix a few trivial mistakes

Axel Rasmussen posted 10 patches 2 years, 4 months ago
There is a newer version of this series
[PATCH 04/10] ioctl_userfaultfd.2: fix a few trivial mistakes
Posted by Axel Rasmussen 2 years, 4 months ago
- Fix missing paragraph tag. The lack of this tag yielded no blank line
  in the rendere dpage, which is inconsistent with style elsewhere.

- The description of UFFDIO_WRITEPROTECT was a sentence fragment; the
  last half of the sentence was left out by mistake. Add it in to fix
  the issue.

- move UFFDIO_WRITEPROTECT 'since' to its own line All other ioctls
  note the kernel version introduced on a separate line from the ioctl
  name. Update UFFDIO_WRITEPROTECT to match the existing style.

Signed-off-by: Axel Rasmussen <axelrasmussen@google.com>
---
 man2/ioctl_userfaultfd.2 | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/man2/ioctl_userfaultfd.2 b/man2/ioctl_userfaultfd.2
index b5281ec4c..339adf8fe 100644
--- a/man2/ioctl_userfaultfd.2
+++ b/man2/ioctl_userfaultfd.2
@@ -31,6 +31,7 @@ using calls of the form:
 ioctl(fd, cmd, argp);
 .EE
 .in
+.PP
 In the above,
 .I fd
 is a file descriptor referring to a userfaultfd object,
@@ -351,6 +352,7 @@ operation is supported.
 .B 1 << _UFFDIO_WRITEPROTECT
 The
 .B UFFDIO_WRITEPROTECT
+operation is supported.
 .TP
 .B 1 << _UFFDIO_ZEROPAGE
 The
@@ -693,7 +695,8 @@ field of the
 structure was not a multiple of the system page size; or
 .I len
 was zero; or the specified range was otherwise invalid.
-.SS UFFDIO_WRITEPROTECT (Since Linux 5.7)
+.SS UFFDIO_WRITEPROTECT
+(Since Linux 5.7.)
 Write-protect or write-unprotect a userfaultfd-registered memory range
 registered with mode
 .BR UFFDIO_REGISTER_MODE_WP .
-- 
2.42.0.459.ge4e396fd5e-goog
Re: [PATCH 04/10] ioctl_userfaultfd.2: fix a few trivial mistakes
Posted by Alejandro Colomar 2 years, 4 months ago
On Tue, Sep 19, 2023 at 12:02:00PM -0700, Axel Rasmussen wrote:
> - Fix missing paragraph tag. The lack of this tag yielded no blank line
>   in the rendere dpage, which is inconsistent with style elsewhere.
> 
> - The description of UFFDIO_WRITEPROTECT was a sentence fragment; the
>   last half of the sentence was left out by mistake. Add it in to fix
>   the issue.
> 
> - move UFFDIO_WRITEPROTECT 'since' to its own line All other ioctls
>   note the kernel version introduced on a separate line from the ioctl
>   name. Update UFFDIO_WRITEPROTECT to match the existing style.
> 
> Signed-off-by: Axel Rasmussen <axelrasmussen@google.com>
> ---

Patch applied.

Thanks,
Alex

>  man2/ioctl_userfaultfd.2 | 5 ++++-
>  1 file changed, 4 insertions(+), 1 deletion(-)
> 
> diff --git a/man2/ioctl_userfaultfd.2 b/man2/ioctl_userfaultfd.2
> index b5281ec4c..339adf8fe 100644
> --- a/man2/ioctl_userfaultfd.2
> +++ b/man2/ioctl_userfaultfd.2
> @@ -31,6 +31,7 @@ using calls of the form:
>  ioctl(fd, cmd, argp);
>  .EE
>  .in
> +.PP
>  In the above,
>  .I fd
>  is a file descriptor referring to a userfaultfd object,
> @@ -351,6 +352,7 @@ operation is supported.
>  .B 1 << _UFFDIO_WRITEPROTECT
>  The
>  .B UFFDIO_WRITEPROTECT
> +operation is supported.
>  .TP
>  .B 1 << _UFFDIO_ZEROPAGE
>  The
> @@ -693,7 +695,8 @@ field of the
>  structure was not a multiple of the system page size; or
>  .I len
>  was zero; or the specified range was otherwise invalid.
> -.SS UFFDIO_WRITEPROTECT (Since Linux 5.7)
> +.SS UFFDIO_WRITEPROTECT
> +(Since Linux 5.7.)
>  Write-protect or write-unprotect a userfaultfd-registered memory range
>  registered with mode
>  .BR UFFDIO_REGISTER_MODE_WP .
> -- 
> 2.42.0.459.ge4e396fd5e-goog
>