bug#15096: 24.3.50; doc string of `read-file-name' - "value is not expanded"

bug#15096: 24.3.50; doc string of `read-file-name' - "value is not expanded"

[Drew Adams]

Beginning of doc string:

  Read file name, prompting with PROMPT and completing in directory DIR.
  Value is not expanded---you must call `expand-file-name' yourself.

What value?  This could easily be misread to be referring to the value
of DIR.  Please say clearly that it is the return value of function
`read-file-name' that is not expanded.

In GNU Emacs 24.3.50.1 (i686-pc-mingw32)
 of 2013-08-07 on ODIEONE
Bzr revision: 113750 lekktu@gmail.com-20130808011911-0jzpc9xuncegg6x9
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/Devel/emacs/binary --enable-checking=yes,glyphs
 CFLAGS=-O0 -g3 LDFLAGS=-Lc:/Devel/emacs/lib
 CPPFLAGS=-Ic:/Devel/emacs/include'

bug#15096: 24.3.50; doc string of `read-file-name' - "value is not expanded"

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> Beginning of doc string:
>
>   Read file name, prompting with PROMPT and completing in directory DIR.
>   Value is not expanded---you must call `expand-file-name' yourself.
>
> What value?  This could easily be misread to be referring to the value
> of DIR.  Please say clearly that it is the return value of function
> `read-file-name' that is not expanded.

Fixed in trunk.

-- 
(domestic pets only, the antidote for overdose, milk.)
  bloggy blog http://lars.ingebrigtsen.no/