unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* doc for locate-file - unclear, typos
@ 2008-02-09  5:47 Drew Adams
  2008-02-09 14:53 ` Eli Zaretskii
  0 siblings, 1 reply; 5+ messages in thread
From: Drew Adams @ 2008-02-09  5:47 UTC (permalink / raw)
  To: bug-gnu-emacs

First, the doc string:
 
 ...
 If SUFFIXES is non-nil, it should be a list of suffixes to append to
 file name when searching.  If SUFFIXES is nil, it is equivalent to '("").
 Use '("/") to disable PATH search, but still try the suffixes in SUFFIXES.
 ...
 
The use and meaning of '("/") is unclear. Is it used for SUFFIXES? In
that case, the last part of the sentence is unclear. Is it used for
PATH? In that case, it is not in the right place (and it's not clear
why that would disable PATH search, instead of just searching under
"/").
 
The Elisp manual, on the other hand, says that an absolute FILENAME
disables PATH ("PATH has no effect"). The manual says nothing about
'("/"), and the doc string says nothing about the use of an absolute
FILENAME.
 
The Elisp manual also has some typos: It has several cross refs that
are followed by periods, all within parentheses in the middle of
sentences. And one of these is split over two lines, with the period
following the newline. This is what it looks like in Info:
 
     Typical values of SUFFIXES are
     `exec-suffixes' (*note exec-suffixes.),
     `load-suffixes', `load-file-rep-suffixes' and the return value of
     the function `get-load-suffixes' (*note Load Suffixes).
 
     Typical values for PATH are `exec-path' (*note exec-path
     .) when looking for executable programs or
     `load-path' (*note load-path.) when looking for
     Lisp files.
 
Each of these references is poorly formatted: "(*noteexec-suffixes.)",
"(*note exec-path
.)", and "(*note load-path.)".  There should be no periods.
 
Note that each "see xxxxxxx." is really "see xxxxxxx:YYYYY YYYYY.", but
that's how it gets formatted in Info. That is, if I copy and paste the
Info text, this is what I get:
 
     Typical values of SUFFIXES are
     `exec-suffixes' (*note exec-suffixes: Subprocess Creation.),
     `load-suffixes', `load-file-rep-suffixes' and the return value of
     the function `get-load-suffixes' (*note Load Suffixes::).
 
     Typical values for PATH are `exec-path' (*note exec-path:
     Subprocess Creation.) when looking for executable programs or
     `load-path' (*note load-path: Library Search.) when looking for
     Lisp files.
 

In GNU Emacs 22.1.1 (i386-mingw-nt5.1.2600)
 of 2007-06-02 on RELEASE
Windowing system distributor `Microsoft Corp.', version 5.1.2600
configured using `configure --with-gcc (3.4) --cflags -Ic:/gnuwin32/include'
 





^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2008-02-09 19:12 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-02-09  5:47 doc for locate-file - unclear, typos Drew Adams
2008-02-09 14:53 ` Eli Zaretskii
2008-02-09 15:55   ` Drew Adams
2008-02-09 16:29     ` Eli Zaretskii
2008-02-09 19:12       ` Drew Adams

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).