diff mbox series

cacheflush.2: Update SYNOPSIS for glibc wrapper

Message ID 20210116145632.7636-1-alx.manpages@gmail.com
State Not Applicable
Headers show
Series cacheflush.2: Update SYNOPSIS for glibc wrapper | expand

Commit Message

Alejandro Colomar Jan. 16, 2021, 2:56 p.m. UTC
Glibc uses 'void *' instead of 'char *'.
And the prototype is declared in <sys/cacheflush.h>.

......

$ syscall='cacheflush';
$ ret='int';
$ find glibc/ -type f -name '*.h' \
  |xargs pcregrep -Mn "(?s)^[\w\s]*${ret}\s*${syscall}\s*\(.*?;";
glibc/sysdeps/unix/sysv/linux/nios2/sys/cachectl.h:27:
extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
glibc/sysdeps/unix/sysv/linux/mips/sys/cachectl.h:35:
extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
glibc/sysdeps/unix/sysv/linux/arc/sys/cachectl.h:30:
extern int cacheflush (void *__addr, int __nbytes, int __op) __THROW;
glibc/sysdeps/unix/sysv/linux/csky/sys/cachectl.h:30:
extern int cacheflush (void *__addr, const int __nbytes,
		       const int __op) __THROW;

Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
---
 man2/cacheflush.2 | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Michael Kerrisk \(man-pages\) Jan. 17, 2021, 8:34 p.m. UTC | #1
Hi Alex,

On 1/16/21 3:56 PM, Alejandro Colomar wrote:
> Glibc uses 'void *' instead of 'char *'.
> And the prototype is declared in <sys/cacheflush.h>.
> 
> ......
> 
> $ syscall='cacheflush';
> $ ret='int';
> $ find glibc/ -type f -name '*.h' \
>   |xargs pcregrep -Mn "(?s)^[\w\s]*${ret}\s*${syscall}\s*\(.*?;";
> glibc/sysdeps/unix/sysv/linux/nios2/sys/cachectl.h:27:
> extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
> glibc/sysdeps/unix/sysv/linux/mips/sys/cachectl.h:35:
> extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
> glibc/sysdeps/unix/sysv/linux/arc/sys/cachectl.h:30:
> extern int cacheflush (void *__addr, int __nbytes, int __op) __THROW;
> glibc/sysdeps/unix/sysv/linux/csky/sys/cachectl.h:30:
> extern int cacheflush (void *__addr, const int __nbytes,
> 		       const int __op) __THROW;
> 
> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>

Thanks. Patch applied.

Cheers,

Michael

> ---
>  man2/cacheflush.2 | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/man2/cacheflush.2 b/man2/cacheflush.2
> index 2cf624f3a..0496879ca 100644
> --- a/man2/cacheflush.2
> +++ b/man2/cacheflush.2
> @@ -27,9 +27,9 @@
>  cacheflush \- flush contents of instruction and/or data cache
>  .SH SYNOPSIS
>  .nf
> -.B #include <asm/cachectl.h>
> +.B #inlcude <sys/cacheflush.h>
>  .PP
> -.BI "int cacheflush(char *" addr ", int "nbytes ", int "cache );
> +.BI "int cacheflush(void *" addr ", int "nbytes ", int "cache );
>  .fi
>  .PP
>  .IR Note :
>
Alejandro Colomar Jan. 17, 2021, 8:43 p.m. UTC | #2
Hi Michael,

On 1/17/21 9:34 PM, Michael Kerrisk (man-pages) wrote:
> Hi Alex,
> 
> On 1/16/21 3:56 PM, Alejandro Colomar wrote:
>> Glibc uses 'void *' instead of 'char *'.
>> And the prototype is declared in <sys/cacheflush.h>.

D'oh!

>>
>> ......
>>
>> $ syscall='cacheflush';
>> $ ret='int';
>> $ find glibc/ -type f -name '*.h' \
>>   |xargs pcregrep -Mn "(?s)^[\w\s]*${ret}\s*${syscall}\s*\(.*?;";
>> glibc/sysdeps/unix/sysv/linux/nios2/sys/cachectl.h:27:

It is defined in <sys/cachectl.h>

Please fix that.

Thanks,

Alex

>> extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
>> glibc/sysdeps/unix/sysv/linux/mips/sys/cachectl.h:35:
>> extern int cacheflush (void *__addr, const int __nbytes, const int __op) __THROW;
>> glibc/sysdeps/unix/sysv/linux/arc/sys/cachectl.h:30:
>> extern int cacheflush (void *__addr, int __nbytes, int __op) __THROW;
>> glibc/sysdeps/unix/sysv/linux/csky/sys/cachectl.h:30:
>> extern int cacheflush (void *__addr, const int __nbytes,
>> 		       const int __op) __THROW;
>>
>> Signed-off-by: Alejandro Colomar <alx.manpages@gmail.com>
> 
> Thanks. Patch applied.
> 
> Cheers,
> 
> Michael
> 
>> ---
>>  man2/cacheflush.2 | 4 ++--
>>  1 file changed, 2 insertions(+), 2 deletions(-)
>>
>> diff --git a/man2/cacheflush.2 b/man2/cacheflush.2
>> index 2cf624f3a..0496879ca 100644
>> --- a/man2/cacheflush.2
>> +++ b/man2/cacheflush.2
>> @@ -27,9 +27,9 @@
>>  cacheflush \- flush contents of instruction and/or data cache
>>  .SH SYNOPSIS
>>  .nf
>> -.B #include <asm/cachectl.h>
>> +.B #inlcude <sys/cacheflush.h>

s/cacheflush.h/cachectl.h/

>>  .PP
>> -.BI "int cacheflush(char *" addr ", int "nbytes ", int "cache );
>> +.BI "int cacheflush(void *" addr ", int "nbytes ", int "cache );
>>  .fi
>>  .PP
>>  .IR Note :
>>
> 
>
Michael Kerrisk \(man-pages\) Jan. 17, 2021, 8:55 p.m. UTC | #3
On 1/17/21 9:43 PM, Alejandro Colomar (man-pages) wrote:
> Hi Michael,
> 
> On 1/17/21 9:34 PM, Michael Kerrisk (man-pages) wrote:
>> Hi Alex,
>>
>> On 1/16/21 3:56 PM, Alejandro Colomar wrote:
>>> Glibc uses 'void *' instead of 'char *'.
>>> And the prototype is declared in <sys/cacheflush.h>.
> 
> D'oh!
> 
>>>
>>> ......
>>>
>>> $ syscall='cacheflush';
>>> $ ret='int';
>>> $ find glibc/ -type f -name '*.h' \
>>>   |xargs pcregrep -Mn "(?s)^[\w\s]*${ret}\s*${syscall}\s*\(.*?;";
>>> glibc/sysdeps/unix/sysv/linux/nios2/sys/cachectl.h:27:
> 
> It is defined in <sys/cachectl.h>
> 
> Please fix that.

Fixed! (Everything pushed now.)
diff mbox series

Patch

diff --git a/man2/cacheflush.2 b/man2/cacheflush.2
index 2cf624f3a..0496879ca 100644
--- a/man2/cacheflush.2
+++ b/man2/cacheflush.2
@@ -27,9 +27,9 @@ 
 cacheflush \- flush contents of instruction and/or data cache
 .SH SYNOPSIS
 .nf
-.B #include <asm/cachectl.h>
+.B #inlcude <sys/cacheflush.h>
 .PP
-.BI "int cacheflush(char *" addr ", int "nbytes ", int "cache );
+.BI "int cacheflush(void *" addr ", int "nbytes ", int "cache );
 .fi
 .PP
 .IR Note :