GNU bug report logs - #13945
`abreviated-home-dir' isn't documented

Previous Next

Full log

Message #8 received at 13945 <at> debbugs.gnu.org (full text, mbox):

From: npostavs <at> users.sourceforge.net
To: Xue Fuqiao <xfq.free <at> gmail.com>
Cc: 13945 <at> debbugs.gnu.org
Subject: Re: bug#13945: `abreviated-home-dir' isn't documented
Date: Sat, 01 Apr 2017 21:59:25 -0400

tags 13945 notabug
close 13945
quit

Xue Fuqiao <xfq.free <at> gmail.com> writes:

> In the source code of `command-line':
>
>   ;; Force recomputation, in case it was computed during the dump.
>   (setq abbreviated-home-dir nil)
>
> The variable `abbreviated-home-dir' (which is defined in files.el) is
> not documented in elisp manual. (Maybe there isn't a need?)

It doesn't need to be documented in the elisp manual, the docstring
should be enough.

> BTW what does the expression above do?  I had searched loadup.el and
> some other files in `lisp/', but I didn't find anything useful.

It forces abbreviated-home-dir to be recomputed next time
abbreviate-file-name is called.

    (defun abbreviate-file-name (filename)
      ...
          (or abbreviated-home-dir
              (setq abbreviated-home-dir
              ...

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.