This is the mail archive of the
mailing list for the glibc project.
Re: [PATCH] Improve the manual on symbolic links.
- From: OndÅej BÃlka <neleai at seznam dot cz>
- To: Fabrice Bauzac <libnoon at gmail dot com>
- Cc: libc-alpha at sourceware dot org
- Date: Sun, 13 Oct 2013 11:30:48 +0200
- Subject: Re: [PATCH] Improve the manual on symbolic links.
- Authentication-results: sourceware.org; auth=none
- References: <CAB6Q1a_dOx9OjPrpgqdSa4oqPBJkJLbeDdBQ9hN0otDKr+TqeQ at mail dot gmail dot com>
On Sat, Oct 12, 2013 at 08:55:03PM +0200, Fabrice Bauzac wrote:
> Hello libc developers,
> I would like to submit a humble contribution to the GNU libc manual.
> Currently the manual documents the symlink() function as this:
> Function: int symlink (const char *oldname, const char *newname)
> The symlink function makes a symbolic link to oldname named newname. [...]
> I find it impractical because, as I can never remember if the symlink
> is the first or second argument, I have to think about OLDNAME and
> NEWNAME to realize that NEWNAME is actually the symlink, while OLDNAME
> the contents of the symlink.
> It has been a long time since I thought it would be clearer if the
> parameters were simply named CONTENTS and FILENAME.
> I have made this change in the attached patch, along with a few
> additions/corrections on filesys.texi.
> Could you please review it?
A better naming would be welcome, I would be for naming them target and
link_name as "man ln" does.
You need an changelog entry which describes changed files in following
* manual/filesys.texi: Describe your change.
Also this change is not legally significant but if you want contribute more
you must fill a copyrigth assignment, see here:
What is legally significant is described here.