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: Jonathan Nieder <jrnieder at gmail dot com>
- To: Florian Weimer <fweimer at redhat dot com>
- Cc: libc-alpha at sourceware dot org
- Date: Fri, 3 Nov 2017 14:52:39 -0700
- Subject: Re: [PATCH] manual: Document the linkat function
- Authentication-results: sourceware.org; auth=none
- References: <20171103213712.ED59B41F1E4EF@oldenburg.str.redhat.com>
Hi,
Florian Weimer wrote:
> 2017-11-03 Florian Weimer <fweimer@redhat.com>
>
> * manual/filesys.texi (Hard Links): Document linkat.
Yay, thanks for writing this.
> --- 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/
[...]
> +@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? 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 ...
> +link to its target. If the flag is not set, a link for the symbolic
> +link itself is created; this is not supported by all file systems and
> +@code{linkat} can fail in this case.
> +
> +@item AT_EMPTY_PATH
> +If this flag is specified, @var{oldname} can be an empty string. In
> +this case, a new link to the file denoted by the descriptor @var{oldfd}
> +is created, which may have been opened with @code{O_PATH} or
> +@code{O_TMPFILE}. This flag is a GNU extension.
> +@end table
> +@end deftypefun
> +
> @node Symbolic Links
> @section Symbolic Links
> @cindex soft link
> @@ -3515,7 +3544,6 @@ The @code{mkdtemp} function comes from OpenBSD.
> @c fchownat
> @c futimesat
> @c fstatat (there's a commented-out safety assessment for this one)
> -@c linkat
> @c mkdirat
> @c mkfifoat
> @c name_to_handle_at
With whatever subset of the tweaks suggested above seems sensible,
Reviewed-by: Jonathan Nieder <jrnieder@gmail.com>
Thanks.