[v5,29/35] ioctl_fat.2: Make clear why is each header exactly needed.

Message ID 20210404115847.78166-30-alx.manpages@gmail.com
State New
Headers show
Series
  • Untitled series #36412
Related show

Commit Message

Martin Sebor via Libc-alpha April 4, 2021, 11:58 a.m.
Only the one that provides the prototype doesn't need a comment.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

---
 man2/ioctl_fat.2 | 1 +
 1 file changed, 1 insertion(+)

-- 
2.31.0

Comments

Martin Sebor via Libc-alpha April 5, 2021, 11:02 a.m. | #1
Hi Alex,

On 4/4/21 1:58 PM, Alejandro Colomar wrote:
> Only the one that provides the prototype doesn't need a comment.

> 

> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

> ---

>  man2/ioctl_fat.2 | 1 +

>  1 file changed, 1 insertion(+)

> 

> diff --git a/man2/ioctl_fat.2 b/man2/ioctl_fat.2

> index 30e410280..263738dad 100644

> --- a/man2/ioctl_fat.2

> +++ b/man2/ioctl_fat.2

> @@ -26,6 +26,7 @@

>  ioctl_fat \- manipulating the FAT filesystem

>  .SH SYNOPSIS

>  .nf

> +.RB "         /* Definition of [" V ] FAT_* " and " ATTR_* " constants */"

>  .B #include <linux/msdos_fs.h>

>  .B #include <sys/ioctl.h>

>  .PP


Patch applied. But, I reformatted in a manner more
typical of what I normally write. See my follow-on commit.

Thanks,

Michael




-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

Patch

diff --git a/man2/ioctl_fat.2 b/man2/ioctl_fat.2
index 30e410280..263738dad 100644
--- a/man2/ioctl_fat.2
+++ b/man2/ioctl_fat.2
@@ -26,6 +26,7 @@ 
 ioctl_fat \- manipulating the FAT filesystem
 .SH SYNOPSIS
 .nf
+.RB "         /* Definition of [" V ] FAT_* " and " ATTR_* " constants */"
 .B #include <linux/msdos_fs.h>
 .B #include <sys/ioctl.h>
 .PP