Fix for lisp/files.el - doc string for file-truename

Fix for lisp/files.el - doc string for file-truename

[CHENG Gao]

Existed doc string for file-truename makes optional parameters not
shown.
Below is the fix. Please check if it's ok.


--- files.el.orig	2004-10-28 18:54:43.031250000 +0800
+++ files.el	2004-10-28 19:42:07.406250000 +0800
@@ -674,9 +674,7 @@
   "Return the truename of FILENAME, which should be absolute.
 The truename of a file name is found by chasing symbolic links
 both at the level of the file and at the level of the directories
-containing it, until no links are left at any level.
-
-\(fn FILENAME)"
+containing it, until no links are left at any level."
   ;; COUNTER and PREV-DIRS are only used in recursive calls.
   ;; COUNTER can be a cons cell whose car is the count of how many
   ;; more links to chase before getting an error.

-- 
花开花谢春不管，拂意事休对人言
水暖水寒鱼自知，会心处还期独赏

Re: Fix for lisp/files.el - doc string for file-truename

[Stefan]

> Existed doc string for file-truename makes optional parameters not
> shown.
> Below is the fix. Please check if it's ok.

As you can see in the comment just below the docstring:

    ;; COUNTER and PREV-DIRS are only used in recursive calls.
    ;; COUNTER can be a cons cell whose car is the count of how many
    ;; more links to chase before getting an error.

I.e. `counter' and `prev-dirs' should normally not be used, which is why
someone went to the trouble to put an explicit (fn FILENAME) to hide those
internal-use-only arguments.


        Stefan


> --- files.el.orig	2004-10-28 18:54:43.031250000 +0800
> +++ files.el	2004-10-28 19:42:07.406250000 +0800
> @@ -674,9 +674,7 @@
>    "Return the truename of FILENAME, which should be absolute.
>  The truename of a file name is found by chasing symbolic links
>  both at the level of the file and at the level of the directories
> -containing it, until no links are left at any level.
> -
> -\(fn FILENAME)"
> +containing it, until no links are left at any level."
>    ;; COUNTER and PREV-DIRS are only used in recursive calls.
>    ;; COUNTER can be a cons cell whose car is the count of how many
>    ;; more links to chase before getting an error.

> -- 
> 花开花谢春不管，拂意事休对人言
> 水暖水寒鱼自知，会心处还期独赏




> _______________________________________________
> Emacs-devel mailing list
> Emacs-devel@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-devel