[Bug manual/16073] New: Improve the manual on symbolic links

["libnoon at gmail dot com" <sourceware-bugzilla at sourceware dot org>]

https://sourceware.org/bugzilla/show_bug.cgi?id=16073

            Bug ID: 16073
           Summary: Improve the manual on symbolic links
           Product: glibc
           Version: unspecified
            Status: NEW
          Severity: normal
          Priority: P2
         Component: manual
          Assignee: unassigned at sourceware dot org
          Reporter: libnoon at gmail dot com
                CC: mtk.manpages at gmail dot com, roland at gnu dot org

Created attachment 7246
  --> https://sourceware.org/bugzilla/attachment.cgi?id=7246&action=edit
The proposed patch.

Hello libc developers,

This is the bugzilla entry for a discussion on libc-help that started on
12OCT2013.

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 TARGET and LINKNAME.

I have made this change in the attached patch, along with a few
additions/corrections on filesys.texi.

Could you please review it?

Thanks!

Best regards
Fabrice

-- 
You are receiving this mail because:
You are on the CC list for the bug.