Re: [PATCH] fchmodat: split kernel/C library documents

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Hi Mike,

On Sun, Apr 22, 2012 at 6:01 AM, Mike Frysinger <vapier@xxxxxxxxxx> wrote:
> On Sunday 15 April 2012 07:15:27 Michael Kerrisk (man-pages) wrote:
>> Take a look at
>> http://www.kernel.org/doc/man-pages/todo.html#migrate_to_kernel_source,
>> which covers what your patch is trying to do. In general, I'm not in favor
>> of patches like this; rather, I try to have a single page where
>> differences (if any) between the system call and libc wrapper are
>> noted. Thus, I'd propose the patch below instead. Seem okay?
>
> i like having dedicated man pages when things are different as the notes
> section tends to get missed at the bottom.  but this change is better than
> nothing.

(Current way of doing things is a design compromise.)

>> --- a/man2/fchmodat.2
>> +++ b/man2/fchmodat.2
>>
>> +This page documents the interface provided by the
>> +glibc wrapper function for the
>
> not to be pedantic, but this isn't glibc specific.  fchmodat() is a POSIX
> interface, so every C library will have this difference.

Yes, it's worth being clearer on that. I applied the patch below.

Cheers,

Michael


--- a/man2/fchmodat.2
+++ b/man2/fchmodat.2
@@ -143,11 +143,9 @@ See
 for an explanation of the need for
 .BR fchmodat ().

-This page documents the interface provided by the
-glibc wrapper function for the
-.BR fchmodat ()
-system call.
-The underlying system call does
+The GNU C library wrapper function implements the POSIX-specified
+interface described in this page.
+This interface differs from the underlying Linux system call, which does
 .I not
 have a
 .I flags



-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Author of "The Linux Programming Interface"; http://man7.org/tlpi/
--
To unsubscribe from this list: send the line "unsubscribe linux-man" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Kernel Documentation]     [Netdev]     [Linux Ethernet Bridging]     [Linux Wireless]     [Kernel Newbies]     [Security]     [Linux for Hams]     [Netfilter]     [Bugtraq]     [Yosemite News]     [MIPS Linux]     [ARM Linux]     [Linux RAID]     [Linux Admin]     [Samba]

  Powered by Linux