[PATCH] getdents.2: SYNOPSIS: Add missing header and feature test macro

[PATCH] getdents.2: SYNOPSIS: Add missing header and feature test macro

[Alejandro Colomar]

Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
---
 man2/getdents.2 | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/man2/getdents.2 b/man2/getdents.2
index 02790b8f7..17904ed66 100644
--- a/man2/getdents.2
+++ b/man2/getdents.2
@@ -35,6 +35,10 @@ getdents, getdents64 \- get directory entries
 .nf
 .BI "int getdents(unsigned int " fd ", struct linux_dirent *" dirp ,
 .BI "             unsigned int " count );
+.PP
+.BR "#define _GNU_SOURCE" "        /* See feature_test_macros(7) */"
+.BR "#include <dirent.h>" "        /* See NOTES */"
+.PP
 .BI "int getdents64(unsigned int " fd ", struct linux_dirent64 *" dirp ,
 .BI "             unsigned int " count );
 .fi
-- 
2.28.0

Re: [PATCH] getdents.2: SYNOPSIS: Add missing header and feature test macro

[Michael Kerrisk (man-pages)]

Hello Alex,

On 10/28/20 8:51 PM, Alejandro Colomar wrote:
> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>

Thanks. Patch applied. But tweaked with a follow-on commit

> ---
>  man2/getdents.2 | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/man2/getdents.2 b/man2/getdents.2
> index 02790b8f7..17904ed66 100644
> --- a/man2/getdents.2
> +++ b/man2/getdents.2
> @@ -35,6 +35,10 @@ getdents, getdents64 \- get directory entries
>  .nf
>  .BI "int getdents(unsigned int " fd ", struct linux_dirent *" dirp ,
>  .BI "             unsigned int " count );
> +.PP
> +.BR "#define _GNU_SOURCE" "        /* See feature_test_macros(7) */"
> +.BR "#include <dirent.h>" "        /* See NOTES */"

I removed the piece "/* See NOTES */", since the NOTES don't
really explain the #include.

> +.PP
>  .BI "int getdents64(unsigned int " fd ", struct linux_dirent64 *" dirp ,
>  .BI "             unsigned int " count );
>  .fi


Cheers,

Michael




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

Re: [PATCH] getdents.2: SYNOPSIS: Add missing header and feature test macro

[Alejandro Colomar]

On 2020-10-28 22:21, Michael Kerrisk (man-pages) wrote:
 > Hello Alex,
 >
 > On 10/28/20 8:51 PM, Alejandro Colomar wrote:
 >> Signed-off-by: Alejandro Colomar <colomar.6.4.3@gmail.com>
 >
 > Thanks. Patch applied. But tweaked with a follow-on commit
 >
 >> ---
 >>   man2/getdents.2 | 4 ++++
 >>   1 file changed, 4 insertions(+)
 >>
 >> diff --git a/man2/getdents.2 b/man2/getdents.2
 >> index 02790b8f7..17904ed66 100644
 >> --- a/man2/getdents.2
 >> +++ b/man2/getdents.2
 >> @@ -35,6 +35,10 @@ getdents, getdents64 \- get directory entries
 >>   .nf
 >>   .BI "int getdents(unsigned int " fd ", struct linux_dirent *" dirp ,
 >>   .BI "             unsigned int " count );
 >> +.PP
 >> +.BR "#define _GNU_SOURCE" "        /* See feature_test_macros(7) */"
 >> +.BR "#include <dirent.h>" "        /* See NOTES */"
 >
 > I removed the piece "/* See NOTES */", since the NOTES don't
 > really explain the #include.

Hi Michael,

Fair enough.

Cheers,

Alex