This is the mail archive of the
libc-alpha@sourceware.org
mailing list for the glibc project.
Re: [PATCH] manual: Document the linkat function
- From: Florian Weimer <fweimer at redhat dot com>
- To: Jonathan Nieder <jrnieder at gmail dot com>
- Cc: libc-alpha at sourceware dot org
- Date: Sat, 4 Nov 2017 00:29:22 +0100
- Subject: Re: [PATCH] manual: Document the linkat function
- Authentication-results: sourceware.org; auth=none
- Authentication-results: ext-mx09.extmail.prod.ext.phx2.redhat.com; dmarc=none (p=none dis=none) header.from=redhat.com
- Authentication-results: ext-mx09.extmail.prod.ext.phx2.redhat.com; spf=fail smtp.mailfrom=fweimer at redhat dot com
- Dmarc-filter: OpenDMARC Filter v1.3.2 mx1.redhat.com BDAC949024
- References: <20171103213712.ED59B41F1E4EF@oldenburg.str.redhat.com> <20171103215239.3a47al2pnwmsa3lh@aiede.mtv.corp.google.com>
On 11/03/2017 10:52 PM, Jonathan Nieder wrote:
--- a/manual/filesys.texi
+++ b/manual/filesys.texi
@@ -1205,6 +1205,35 @@ A hardware error occurred while trying to read or write the to filesystem.
@end table
@end deftypefun
+@deftypefun int linkat (int olfd, const char *@var{oldname}, int newfd, const char *@var{newname}, int flags)
s/olfd/oldfd/
Thanks, fixed.
[...]
+@table @code
+@item AT_SYMLINK_FOLLOW
+If the source path denoted by @var{oldfd} and @var{oldname} is a
+symbolic link, @code{linkat} follows the symbolic link and creates a
usage nit: "denoted" does not seem like the right word. Maybe
"identified", to match the wording used above?
Okay, let's use identified.
Or perhaps something
like the following:
If the file @{oldname} in the directory associated to @var{oldfd}
is a symbolic link, @code{linkat} follows the ...
That's not quite accurate because the name does not have to be located
in that directory, it is only resolved relative to it.
With whatever subset of the tweaks suggested above seems sensible,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Pushed with the changes above.
Thanks,
Florian