From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" Newsgroups: gmane.emacs.bugs Subject: doc for locate-file - unclear, typos Date: Fri, 8 Feb 2008 21:47:52 -0800 Message-ID: <000901c86adf$4fa31c00$a350908d@us.oracle.com> NNTP-Posting-Host: lo.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: ger.gmane.org 1202536128 4860 80.91.229.12 (9 Feb 2008 05:48:48 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 9 Feb 2008 05:48:48 +0000 (UTC) To: Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Feb 09 06:49:10 2008 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([199.232.76.165]) by lo.gmane.org with esmtp (Exim 4.50) id 1JNiaK-0005wU-LF for geb-bug-gnu-emacs@m.gmane.org; Sat, 09 Feb 2008 06:49:08 +0100 Original-Received: from localhost ([127.0.0.1] helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JNiZr-0001Xv-R4 for geb-bug-gnu-emacs@m.gmane.org; Sat, 09 Feb 2008 00:48:39 -0500 Original-Received: from mailman by lists.gnu.org with tmda-scanned (Exim 4.43) id 1JNiZX-0001Q7-0h for bug-gnu-emacs@gnu.org; Sat, 09 Feb 2008 00:48:19 -0500 Original-Received: from exim by lists.gnu.org with spam-scanned (Exim 4.43) id 1JNiZV-0001Pv-4h for bug-gnu-emacs@gnu.org; Sat, 09 Feb 2008 00:48:18 -0500 Original-Received: from [199.232.76.173] (helo=monty-python.gnu.org) by lists.gnu.org with esmtp (Exim 4.43) id 1JNiZU-0001Ps-QL for bug-gnu-emacs@gnu.org; Sat, 09 Feb 2008 00:48:16 -0500 Original-Received: from rgminet01.oracle.com ([148.87.113.118]) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1JNiZU-0003Gh-EA for bug-gnu-emacs@gnu.org; Sat, 09 Feb 2008 00:48:16 -0500 Original-Received: from rgmgw1.us.oracle.com (rgmgw1.us.oracle.com [138.1.186.110]) by rgminet01.oracle.com (Switch-3.2.4/Switch-3.1.6) with ESMTP id m195mD3a030064 for ; Fri, 8 Feb 2008 22:48:13 -0700 Original-Received: from acsmt351.oracle.com (acsmt351.oracle.com [141.146.40.151]) by rgmgw1.us.oracle.com (Switch-3.2.4/Switch-3.2.4) with ESMTP id m195BoQ1018663 for ; Fri, 8 Feb 2008 22:48:13 -0700 Original-Received: from inet-141-146-46-1.oracle.com by acsmt350.oracle.com with ESMTP id 3567690391202536058; Fri, 08 Feb 2008 21:47:38 -0800 Original-Received: from dradamslap1 (/141.144.80.163) by bhmail.oracle.com (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 08 Feb 2008 21:47:38 -0800 X-Mailer: Microsoft Office Outlook 11 Thread-Index: Achq307kn/kY33ytSwWzJljOAc0daA== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3198 X-Brightmail-Tracker: AAAAAQAAAAI= X-Brightmail-Tracker: AAAAAQAAAAI= X-Whitelist: TRUE X-Whitelist: TRUE X-detected-kernel: by monty-python.gnu.org: Linux 2.4-2.6 X-BeenThere: bug-gnu-emacs@gnu.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:17508 Archived-At: 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'