From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: "Drew Adams" <drew.adams@oracle.com> Newsgroups: gmane.emacs.bugs Subject: bug#10879: 24.0.93; doc for `find-file' et al is missing the return value Date: Fri, 24 Feb 2012 09:07:28 -0800 Message-ID: <73CE0A02B9B0423CA105B7BF7417831B@us.oracle.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Trace: dough.gmane.org 1330103326 5480 80.91.229.3 (24 Feb 2012 17:08:46 GMT) X-Complaints-To: usenet@dough.gmane.org NNTP-Posting-Date: Fri, 24 Feb 2012 17:08:46 +0000 (UTC) To: 10879@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Fri Feb 24 18:08:44 2012 Return-path: <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org> Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([140.186.70.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org>) id 1S0ydM-0004h4-IJ for geb-bug-gnu-emacs@m.gmane.org; Fri, 24 Feb 2012 18:08:41 +0100 Original-Received: from localhost ([::1]:41122 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org>) id 1S0ydL-0008Pq-Hg for geb-bug-gnu-emacs@m.gmane.org; Fri, 24 Feb 2012 12:08:39 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:53326) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1S0ydD-0008Ow-LJ for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:08:37 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1S0yd9-0004JB-EO for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:08:31 -0500 Original-Received: from debbugs.gnu.org ([140.186.70.43]:52499) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1S0yd9-0004J5-AY for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:08:27 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.72) (envelope-from <Debian-debbugs@debbugs.gnu.org>) id 1S0yfd-0003vp-NP for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:11:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: "Drew Adams" <drew.adams@oracle.com> Original-Sender: debbugs-submit-bounces@debbugs.gnu.org Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Fri, 24 Feb 2012 17:11:01 +0000 Resent-Message-ID: <handler.10879.B.133010343515078@debbugs.gnu.org> Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 10879 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: X-Debbugs-Original-To: <bug-gnu-emacs@gnu.org> Original-Received: via spool by submit@debbugs.gnu.org id=B.133010343515078 (code B ref -1); Fri, 24 Feb 2012 17:11:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 24 Feb 2012 17:10:35 +0000 Original-Received: from localhost ([127.0.0.1]:54396 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from <debbugs-submit-bounces@debbugs.gnu.org>) id 1S0yfD-0003v9-GV for submit@debbugs.gnu.org; Fri, 24 Feb 2012 12:10:35 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:48186) by debbugs.gnu.org with esmtp (Exim 4.72) (envelope-from <drew.adams@oracle.com>) id 1S0yfA-0003uw-FM for submit@debbugs.gnu.org; Fri, 24 Feb 2012 12:10:34 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <drew.adams@oracle.com>) id 1S0ycW-0004FJ-2e for submit@debbugs.gnu.org; Fri, 24 Feb 2012 12:07:52 -0500 Original-Received: from lists.gnu.org ([140.186.70.17]:40514) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <drew.adams@oracle.com>) id 1S0ycV-0004FF-UD for submit@debbugs.gnu.org; Fri, 24 Feb 2012 12:07:48 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:53201) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from <drew.adams@oracle.com>) id 1S0ycR-0008K4-L1 for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:07:47 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from <drew.adams@oracle.com>) id 1S0ycL-0004EY-QV for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:07:43 -0500 Original-Received: from rcsinet15.oracle.com ([148.87.113.117]:24866) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from <drew.adams@oracle.com>) id 1S0ycL-0004EM-Jq for bug-gnu-emacs@gnu.org; Fri, 24 Feb 2012 12:07:37 -0500 Original-Received: from acsinet21.oracle.com (acsinet21.oracle.com [141.146.126.237]) by rcsinet15.oracle.com (Sentrion-MTA-4.2.2/Sentrion-MTA-4.2.2) with ESMTP id q1OH7XFh009259 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for <bug-gnu-emacs@gnu.org>; Fri, 24 Feb 2012 17:07:34 GMT Original-Received: from acsmt358.oracle.com (acsmt358.oracle.com [141.146.40.158]) by acsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id q1OH7XYn000735 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for <bug-gnu-emacs@gnu.org>; Fri, 24 Feb 2012 17:07:33 GMT Original-Received: from abhmt105.oracle.com (abhmt105.oracle.com [141.146.116.57]) by acsmt358.oracle.com (8.12.11.20060308/8.12.11) with ESMTP id q1OH7W3N012123 for <bug-gnu-emacs@gnu.org>; Fri, 24 Feb 2012 11:07:32 -0600 Original-Received: from dradamslap1 (/10.159.39.252) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Fri, 24 Feb 2012 09:07:32 -0800 X-Mailer: Microsoft Office Outlook 11 Thread-Index: AczzFsm0l10TEXtQQcuKZY1JVTFUew== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.6157 X-Source-IP: acsinet21.oracle.com [141.146.126.237] X-CT-RefId: str=0001.0A090207.4F47C3D6.0116,ss=1,re=0.000,fgs=0 X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 1) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 3) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.13 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6 (newer, 2) X-Received-From: 140.186.70.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" <bug-gnu-emacs.gnu.org> List-Unsubscribe: <https://lists.gnu.org/mailman/options/bug-gnu-emacs>, <mailto:bug-gnu-emacs-request@gnu.org?subject=unsubscribe> List-Archive: <http://lists.gnu.org/archive/html/bug-gnu-emacs> List-Post: <mailto:bug-gnu-emacs@gnu.org> List-Help: <mailto:bug-gnu-emacs-request@gnu.org?subject=help> List-Subscribe: <https://lists.gnu.org/mailman/listinfo/bug-gnu-emacs>, <mailto:bug-gnu-emacs-request@gnu.org?subject=subscribe> Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.bugs:57183 Archived-At: <http://permalink.gmane.org/gmane.emacs.bugs/57183> There are several places in the Emacs source code where `find-file' and similar commands are used programmatically - typically when defining other commands, such as `find-file-read-only'. Similarly, 3rd-party code can sometimes use such a command programmatically, for similar reasons. Code such as the definition of `find-file-read-only' uses the return value of `find-file'. The bug is that this return value is not documented - it should be. The return value is documented only for `find-file-noselect'. It would be sufficient for the `find-file' et al doc to say that the return value of the function is the same as for `find-find-noselect'. Please add this info to the doc strings and the Elisp manual doc for the `find-file' family of commands. In GNU Emacs 24.0.93.1 (i386-mingw-nt5.1.2600) of 2012-02-15 on MARVIN Windowing system distributor `Microsoft Corp.', version 5.1.2600 Configured using: `configure --with-gcc (4.6) --no-opt --enable-checking --cflags -ID:/devel/emacs/libs/libXpm-3.5.8/include -ID:/devel/emacs/libs/libXpm-3.5.8/src -ID:/devel/emacs/libs/libpng-dev_1.4.3-1/include -ID:/devel/emacs/libs/zlib-dev_1.2.5-2/include -ID:/devel/emacs/libs/giflib-4.1.4-1/include -ID:/devel/emacs/libs/jpeg-6b-4/include -ID:/devel/emacs/libs/tiff-3.8.2-1/include -ID:/devel/emacs/libs/gnutls-3.0.9/include'