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: bug#18202: 24.4.50; doc string of `next-error-buffer-p' Date: Tue, 5 Aug 2014 12:52:03 -0700 (PDT) Message-ID: NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1407268419 26350 80.91.229.3 (5 Aug 2014 19:53:39 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Tue, 5 Aug 2014 19:53:39 +0000 (UTC) To: 18202@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Aug 05 21:53:32 2014 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1XEknb-0000be-LN for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Aug 2014 21:53:31 +0200 Original-Received: from localhost ([::1]:33249 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEknY-0004o4-6Z for geb-bug-gnu-emacs@m.gmane.org; Tue, 05 Aug 2014 15:53:28 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40324) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEknJ-0004n4-1I for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:53:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkn8-0007jo-Kc for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:53:12 -0400 Original-Received: from debbugs.gnu.org ([140.186.70.43]:52256) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkn8-0007jk-G6 for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:53:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.80) (envelope-from ) id 1XEkn7-0002gA-Ps for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:53:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Drew Adams Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 05 Aug 2014 19:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 18202 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.140726836610273 (code B ref -1); Tue, 05 Aug 2014 19:53:01 +0000 Original-Received: (at submit) by debbugs.gnu.org; 5 Aug 2014 19:52:46 +0000 Original-Received: from localhost ([127.0.0.1]:59199 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEkmr-0002fb-C8 for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:52:45 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:38527) by debbugs.gnu.org with esmtp (Exim 4.80) (envelope-from ) id 1XEkmo-0002fH-IQ for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:52:43 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkmY-0007V8-MQ for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:52:36 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:41009) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkmY-0007Us-It for submit@debbugs.gnu.org; Tue, 05 Aug 2014 15:52:26 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40187) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkmP-0004mM-O9 for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:52:26 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1XEkmG-0007MC-Sg for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:52:17 -0400 Original-Received: from userp1040.oracle.com ([156.151.31.81]:50324) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1XEkmG-0007M6-Ij for bug-gnu-emacs@gnu.org; Tue, 05 Aug 2014 15:52:08 -0400 Original-Received: from ucsinet21.oracle.com (ucsinet21.oracle.com [156.151.31.93]) by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id s75Jq6p4027144 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Tue, 5 Aug 2014 19:52:07 GMT Original-Received: from userz7022.oracle.com (userz7022.oracle.com [156.151.31.86]) by ucsinet21.oracle.com (8.14.4+Sun/8.14.4) with ESMTP id s75Jq5MX011958 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NO) for ; Tue, 5 Aug 2014 19:52:06 GMT Original-Received: from abhmp0005.oracle.com (abhmp0005.oracle.com [141.146.116.11]) by userz7022.oracle.com (8.14.5+Sun/8.14.4) with ESMTP id s75Jq4pn019256 for ; Tue, 5 Aug 2014 19:52:05 GMT X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.8 (707110) [OL 12.0.6691.5000 (x86)] X-Source-IP: ucsinet21.oracle.com [156.151.31.93] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic] X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.15 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x 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" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-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:92157 Archived-At: The doc string: Test if BUFFER is a `next-error' capable buffer. If AVOID-CURRENT is non-nil, treat the current buffer as an absolute last resort only. The function EXTRA-TEST-INCLUSIVE, if non-nil, is called in each buffer that normally would not qualify. If it returns t, the buffer in question is treated as usable. The function EXTRA-TEST-EXCLUSIVE, if non-nil, is called in each buffer that would normally be considered usable. If it returns nil, that buffer is rejected. The doc string is very poor. 1. The first line should say that the predicate returns non-nil if BUFFER is a `next-error'-capable buffer. 2. The doc string should then give some indication of what that means (what it means for a buffer to be `next-error'-capable). 3. The description of AVOID-CURRENT says nothing. It needs to say what the behavior is and how it affects the return value (if it does). "Treat the buffer" means nothing here, as does "as a last resort." 4. The other two paragraphs: What does it mean (a) for a buffer to "qualify" or "normally be considered usable" ("normally"? What does that mean here?), and (b) for a buffer to be "usable" or "rejected"? Again, this text says nothing helpful. It should say what the behavior is. Presumably, the last sentence in each of these paragraphs should say "If it returns [t|nil] then so does `next-error-buffer-p'." There really is nothing good about this doc string. =20 In GNU Emacs 24.4.50.1 (i686-pc-mingw32) of 2014-06-28 on ODIEONE Bzr revision: 117431 rgm@gnu.org-20140628015517-eku6hj8mpgcvfnso Windowing system distributor `Microsoft Corp.', version 6.1.7601 Configured using: `configure --prefix=3D/c/Devel/emacs/snapshot/trunk --enable-checking=3Dyes,glyphs 'CFLAGS=3D-O0 -g3' LDFLAGS=3D-Lc:/Devel/emacs/lib 'CPPFLAGS=3D-DGC_MCHECK=3D1 -Ic:/Devel/emacs/include''