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

Message ID 20210404115847.78166-35-alx.manpages@gmail.com
State Not applicable
Headers
Series None |

Commit Message

Alejandro Colomar April 4, 2021, 11:58 a.m. UTC
  Only the include that provides the prototype doesn't need a comment.

Also sort the includes alphabetically.

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man2/ioctl_fslabel.2 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
  

Comments

Michael Kerrisk \(man-pages\) April 5, 2021, 11:04 a.m. UTC | #1
Hi Alex,

On 4/4/21 1:58 PM, Alejandro Colomar wrote:
> Only the include that provides the prototype doesn't need a comment.
> 
> Also sort the includes alphabetically.
> 
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>


Patch applied.

Thanks,

Michael


> ---
>  man2/ioctl_fslabel.2 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/man2/ioctl_fslabel.2 b/man2/ioctl_fslabel.2
> index af17256f0..30435e1e9 100644
> --- a/man2/ioctl_fslabel.2
> +++ b/man2/ioctl_fslabel.2
> @@ -25,8 +25,8 @@
>  ioctl_fslabel \- get or set a filesystem label
>  .SH SYNOPSIS
>  .nf
> +.BR "#include <linux/fs.h>" "       /* Definition of " *FSLABEL* " constants */"
>  .B #include <sys/ioctl.h>
> -.B #include <linux/fs.h>
>  .PP
>  .BI "int ioctl(int " fd ", FS_IOC_GETFSLABEL, char " label [FSLABEL_MAX]);
>  .BI "int ioctl(int " fd ", FS_IOC_SETFSLABEL, char " label [FSLABEL_MAX]);
>
  

Patch

diff --git a/man2/ioctl_fslabel.2 b/man2/ioctl_fslabel.2
index af17256f0..30435e1e9 100644
--- a/man2/ioctl_fslabel.2
+++ b/man2/ioctl_fslabel.2
@@ -25,8 +25,8 @@ 
 ioctl_fslabel \- get or set a filesystem label
 .SH SYNOPSIS
 .nf
+.BR "#include <linux/fs.h>" "       /* Definition of " *FSLABEL* " constants */"
 .B #include <sys/ioctl.h>
-.B #include <linux/fs.h>
 .PP
 .BI "int ioctl(int " fd ", FS_IOC_GETFSLABEL, char " label [FSLABEL_MAX]);
 .BI "int ioctl(int " fd ", FS_IOC_SETFSLABEL, char " label [FSLABEL_MAX]);