emacs-devel
[Top][All Lists]
Advanced

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

Re: Docstring of make-symbolic-link


From: Eli Zaretskii
Subject: Re: Docstring of make-symbolic-link
Date: Tue, 11 Jun 2019 17:22:46 +0300

> From: Juanma Barranquero <address@hidden>
> Date: Mon, 10 Jun 2019 21:44:46 +0200
> 
> make-symbolic link uses NEWNAME in its docstring, but LINKNAME as the
> argument name:
> 
>   (make-symbolic-link TARGET LINKNAME &optional OK-IF-ALREADY-EXISTS)
> 
>   Make a symbolic link to TARGET, named NEWNAME.
>   If NEWNAME is a directory name, make a like-named symbolic link under
>   NEWNAME.
> 
>   [etc...]

This appears to be some kind of copy-pasta from add-name-to-file,
which creates a hard link.

> The easiest way to fix it is to change NEWNAME to LINKNAME in the
> docstring, but I think NEWNAME is the preferred name, and it is also
> used in the info files.
> 
> The alternative is to change linkname to newname in the code, and
> encoded_linkname to encoded_newname (not required, but for
> consistency).
> 
> It is a trivial change, but as it touches code in 26.2.50, better safe
> than sorry. So, newname everywhere, or linkname everywhere (including
> the info files)?

My vote is for LINKNAME.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]