From unknown Wed Jun 18 23:18:17 2025 X-Loop: don@donarmstrong.com Subject: bug#1424: 23.0.60; nil vs `nil' in manuals Reply-To: "Drew Adams" , 1424@debbugs.gnu.org Resent-From: "Drew Adams" Resent-To: bug-submit-list@lists.donarmstrong.com Resent-CC: Emacs Bugs Resent-Date: Mon, 24 Nov 2008 22:50:03 +0000 Resent-Message-ID: Resent-Sender: don@donarmstrong.com X-Emacs-PR-Message: report 1424 X-Emacs-PR-Package: emacs X-Emacs-PR-Keywords: Received: via spool by submit@emacsbugs.donarmstrong.com id=B.12275665908599 (code B ref -1); Mon, 24 Nov 2008 22:50:03 +0000 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-7.1 required=4.0 tests=AWL,BAYES_00,FOURLA, RCVD_IN_DNSWL_MED,UNPARSEABLE_RELAY autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at submit) by emacsbugs.donarmstrong.com; 24 Nov 2008 22:43:10 +0000 Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id mAOMh6Co008588 for ; Mon, 24 Nov 2008 14:43:07 -0800 Received: from mail.gnu.org ([199.232.76.166]:44101 helo=mx10.gnu.org) by fencepost.gnu.org with esmtp (Exim 4.67) (envelope-from ) id 1L4k8n-0002h8-TV for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:42:50 -0500 Received: from Debian-exim by monty-python.gnu.org with spam-scanned (Exim 4.60) (envelope-from ) id 1L4k90-00057J-Fd for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:43:04 -0500 Received: from rcsinet13.oracle.com ([148.87.113.125]:35986 helo=rgminet13.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1L4k8z-000572-VA for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:43:02 -0500 Received: from rgminet15.oracle.com (rcsinet15.oracle.com [148.87.113.117]) by rgminet13.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id mAOMhEc0026274 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 24 Nov 2008 22:43:18 GMT Received: from acsmt705.oracle.com (acsmt705.oracle.com [141.146.40.83]) by rgminet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id mAOMgvlf001736 for ; Mon, 24 Nov 2008 22:42:58 GMT Received: from dradamslap1 (/130.35.178.194) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Mon, 24 Nov 2008 14:42:51 -0800 From: "Drew Adams" To: Date: Mon, 24 Nov 2008 14:42:53 -0800 Message-ID: <006301c94e85$fd21fdd0$c2b22382@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AclOhfzaWjfjt89yQleZLQxWFgExTg== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3350 X-Source-IP: acsmt705.oracle.com [141.146.40.83] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090209.492B2DEC.021C:SCFSTAT928724,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) Most of the time, outside code examples, "nil" is written "`nil'" in the manuals (I'm looking at Info). Here are some exceptions, which I think are typos. Emacs manual: * Node Watch Expressions If the variable `gdb-delete-out-of-scope' is non-`nil' (the default value), Emacs automatically deletes watch expressions which go out of scope. Sometimes, when re-entering the same function, it may be useful to set this value to nil so that you don't need to recreate ^^^ the watch expression. Elisp manual: * Node `nil and t': Function: booleanp object Return non-nil if OBJECT is one of the two canonical boolean ^^^ values: `t' or `nil'. * Node Predicates for Strings Function: string-or-null-p object This function returns `t' if OBJECT is a string or nil, `nil' ^^^ otherwise. * Node Declaring Functions Macro: declare-function function file &optional arglist fileonly Tell the byte compiler to assume that FUNCTION is defined, with arguments ARGLIST, and that the definition should come from the file FILE. FILEONLY non-nil means only check that FILE exists, ^^^ not that it actually defines FUNCTION. * Node Key Sequence When reading input results in such a "shift-translation", Emacs sets the variable `this-command-keys-shift-translated' to a non-nil value. ^^^ * Node Changing Files Function: file-modes-symbolic-to-number modes &optional base-modes This subroutine converts a symbolic specification of file mode bits in MODES into the equivalent numeric value. If the symbolic specification is based on an existing file, that file's mode bits are taken from the optional argument BASE-MODES; if that argument is omitted or nil, it defaults to zero, i.e. no access rights at ^^^ all. * Node Magic File Names Function: unhandled-file-name-directory filename This function returns the name of a directory that is not magic. It uses the directory part of FILENAME if that is not magic. For a magic file name, it invokes the file name handler, which therefore decides what value to return. If FILENAME is not accessible from a local process, then the file name handler should indicate it by returning nil. ^^^ * Node Selecting Windows Macro: with-selected-window window forms... This macro selects WINDOW, executes FORMS in sequence, then restores the previously selected window and current buffer. The ordering of recently selected windows and the buffer list remain unchanged unless you deliberately change them within FORMS, for example, by calling `select-window' with argument NORECORD nil or ^^^ omitted there. * Node Choosing Window User Option: pop-up-windows This variable specifies whether `display-buffer' is allowed to split (*note Splitting Windows::) an existing window . If it is non-`nil', `display-buffer' tries to the split the largest or least recently used window on the selected frame. (If the selected frame is a minibuffer-only frame, it tries to split a window on another frame instead.) If `pop-up-windows' is nil or the variable ^^^ `pop-up-frames' (see below) is non-`nil', `display-buffer' does not split any window. * Node The Mark Function: handle-shift-selection &optional deactivate This function checks whether the current command was invoked via shift translation (*note shift-translation: Key Sequence Input.), and if so, sets the mark and temporarily activates the region, unless the region is already temporarily activated in this way. If the command was invoked without shift translation, or if the optional argument DEACTIVATE is non-nil, the function deactivates ^^^ the mark. This function is called whenever a command with a `^' character in its `interactive' spec (*note ^: Interactive Codes.) is invoked while `shift-select-mode' (*note Shift Selection: (emacs)Shift Selection.) is non-`nil'. * Node Shell Arguments If SEPARATORS is omitted or nil, it defaults to `"\\s-+"', which ^^^ is a regular expression that matches one or more characters with whitespace syntax (*note Syntax Class Table::). * Node Transaction Queues If the argument DELAY-QUESTION is non-nil, delay sending this ^^^ question until the process has finished replying to any previous questions. This produces more reliable results with some processes. * Node Proceessor Run Time If FORMAT is nil or omitted, it defaults to `"%Y, %D, %H, %M, %z%S"'. ^^^ * Node Documentation Tips When a documentation string refers to a Lisp symbol, write it as it would be printed (which usually means in lower case), with single-quotes around it. For example: `lambda'. There are two exceptions: write t and nil without single-quotes. (In this ^ ^^^ manual, we use a different convention, with single-quotes for all symbols.) Actually, those two should probably be written in double quotes, since we are referring to the text, not to the symbols, when talking about "t" and "nil" here. In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600) of 2008-11-08 on LENNART-69DE564 Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include -fno-crossjumping' From unknown Wed Jun 18 23:18:17 2025 MIME-Version: 1.0 X-Mailer: MIME-tools 5.420 (Entity 5.420) X-Loop: don@donarmstrong.com From: help-debbugs@gnu.org (Emacs bug Tracking System) To: "Drew Adams" Subject: bug#1424 closed by Chong Yidong (Re: 23.0.60; nil vs `nil' in manuals) Message-ID: References: <87hc5wtq7b.fsf@cyd.mit.edu> <006301c94e85$fd21fdd0$c2b22382@us.oracle.com> X-Emacs-PR-Message: they-closed 1424 X-Emacs-PR-Package: emacs Reply-To: 1424@debbugs.gnu.org Content-Type: multipart/mixed; boundary="----------=_1227585604-26446-1" This is a multi-part message in MIME format... ------------=_1227585604-26446-1 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable Content-Type: text/plain; charset="utf-8" This is an automatic notification regarding your bug report which was filed against the emacs package: #1424: 23.0.60; nil vs `nil' in manuals It has been closed by Chong Yidong . Their explanation is attached below along with your original report. If this explanation is unsatisfactory and you have not received a better one in a separate message then please contact Chong Yidong by replying to this email. --=20 1424: http://debbugs.gnu.org/cgi/bugreport.cgi?bug=3D1424 Emacs Bug Tracking System Contact help-debbugs@gnu.org with problems ------------=_1227585604-26446-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit >From cyd@stupidchicken.com Mon Nov 24 19:54:47 2008 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-4.0 required=4.0 tests=AWL,BAYES_00 autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at 1424-done) by emacsbugs.donarmstrong.com; 25 Nov 2008 03:54:47 +0000 Received: from cyd.mit.edu (CYD.MIT.EDU [18.115.2.24]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id mAP3siQg025133 for <1424-done@emacsbugs.donarmstrong.com>; Mon, 24 Nov 2008 19:54:46 -0800 Received: by cyd.mit.edu (Postfix, from userid 1000) id 329BE57E1C8; Mon, 24 Nov 2008 22:55:04 -0500 (EST) From: Chong Yidong To: "Drew Adams" Cc: 1424-done@debbugs.gnu.org Subject: Re: 23.0.60; nil vs `nil' in manuals Date: Mon, 24 Nov 2008 22:55:04 -0500 Message-ID: <87hc5wtq7b.fsf@cyd.mit.edu> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Thanks very much for pointing out these typos. I've checked in fixes (except for the last case, in which I think the intention is to leave `nil' completely unquoted.) ------------=_1227585604-26446-1 Content-Type: message/rfc822 Content-Disposition: inline Content-Transfer-Encoding: 7bit >From drew.adams@oracle.com Mon Nov 24 14:43:10 2008 X-Spam-Checker-Version: SpamAssassin 3.2.3-bugs.debian.org_2005_01_02 (2007-08-08) on rzlab.ucr.edu X-Spam-Level: X-Spam-Status: No, score=-7.1 required=4.0 tests=AWL,BAYES_00,FOURLA, RCVD_IN_DNSWL_MED,UNPARSEABLE_RELAY autolearn=ham version=3.2.3-bugs.debian.org_2005_01_02 Received: (at submit) by emacsbugs.donarmstrong.com; 24 Nov 2008 22:43:10 +0000 Received: from fencepost.gnu.org (fencepost.gnu.org [140.186.70.10]) by rzlab.ucr.edu (8.13.8/8.13.8/Debian-3) with ESMTP id mAOMh6Co008588 for ; Mon, 24 Nov 2008 14:43:07 -0800 Received: from mail.gnu.org ([199.232.76.166]:44101 helo=mx10.gnu.org) by fencepost.gnu.org with esmtp (Exim 4.67) (envelope-from ) id 1L4k8n-0002h8-TV for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:42:50 -0500 Received: from Debian-exim by monty-python.gnu.org with spam-scanned (Exim 4.60) (envelope-from ) id 1L4k90-00057J-Fd for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:43:04 -0500 Received: from rcsinet13.oracle.com ([148.87.113.125]:35986 helo=rgminet13.oracle.com) by monty-python.gnu.org with esmtps (TLS-1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.60) (envelope-from ) id 1L4k8z-000572-VA for emacs-pretest-bug@gnu.org; Mon, 24 Nov 2008 17:43:02 -0500 Received: from rgminet15.oracle.com (rcsinet15.oracle.com [148.87.113.117]) by rgminet13.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id mAOMhEc0026274 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK) for ; Mon, 24 Nov 2008 22:43:18 GMT Received: from acsmt705.oracle.com (acsmt705.oracle.com [141.146.40.83]) by rgminet15.oracle.com (Switch-3.3.1/Switch-3.3.1) with ESMTP id mAOMgvlf001736 for ; Mon, 24 Nov 2008 22:42:58 GMT Received: from dradamslap1 (/130.35.178.194) by default (Oracle Beehive Gateway v4.0) with ESMTP ; Mon, 24 Nov 2008 14:42:51 -0800 From: "Drew Adams" To: Subject: 23.0.60; nil vs `nil' in manuals Date: Mon, 24 Nov 2008 14:42:53 -0800 Message-ID: <006301c94e85$fd21fdd0$c2b22382@us.oracle.com> MIME-Version: 1.0 Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit X-Mailer: Microsoft Office Outlook 11 Thread-Index: AclOhfzaWjfjt89yQleZLQxWFgExTg== X-MimeOLE: Produced By Microsoft MimeOLE V6.00.2900.3350 X-Source-IP: acsmt705.oracle.com [141.146.40.83] X-Auth-Type: Internal IP X-CT-RefId: str=0001.0A090209.492B2DEC.021C:SCFSTAT928724,ss=1,fgs=0 X-detected-operating-system: by monty-python.gnu.org: GNU/Linux 2.6 (newer, 1) Most of the time, outside code examples, "nil" is written "`nil'" in the manuals (I'm looking at Info). Here are some exceptions, which I think are typos. Emacs manual: * Node Watch Expressions If the variable `gdb-delete-out-of-scope' is non-`nil' (the default value), Emacs automatically deletes watch expressions which go out of scope. Sometimes, when re-entering the same function, it may be useful to set this value to nil so that you don't need to recreate ^^^ the watch expression. Elisp manual: * Node `nil and t': Function: booleanp object Return non-nil if OBJECT is one of the two canonical boolean ^^^ values: `t' or `nil'. * Node Predicates for Strings Function: string-or-null-p object This function returns `t' if OBJECT is a string or nil, `nil' ^^^ otherwise. * Node Declaring Functions Macro: declare-function function file &optional arglist fileonly Tell the byte compiler to assume that FUNCTION is defined, with arguments ARGLIST, and that the definition should come from the file FILE. FILEONLY non-nil means only check that FILE exists, ^^^ not that it actually defines FUNCTION. * Node Key Sequence When reading input results in such a "shift-translation", Emacs sets the variable `this-command-keys-shift-translated' to a non-nil value. ^^^ * Node Changing Files Function: file-modes-symbolic-to-number modes &optional base-modes This subroutine converts a symbolic specification of file mode bits in MODES into the equivalent numeric value. If the symbolic specification is based on an existing file, that file's mode bits are taken from the optional argument BASE-MODES; if that argument is omitted or nil, it defaults to zero, i.e. no access rights at ^^^ all. * Node Magic File Names Function: unhandled-file-name-directory filename This function returns the name of a directory that is not magic. It uses the directory part of FILENAME if that is not magic. For a magic file name, it invokes the file name handler, which therefore decides what value to return. If FILENAME is not accessible from a local process, then the file name handler should indicate it by returning nil. ^^^ * Node Selecting Windows Macro: with-selected-window window forms... This macro selects WINDOW, executes FORMS in sequence, then restores the previously selected window and current buffer. The ordering of recently selected windows and the buffer list remain unchanged unless you deliberately change them within FORMS, for example, by calling `select-window' with argument NORECORD nil or ^^^ omitted there. * Node Choosing Window User Option: pop-up-windows This variable specifies whether `display-buffer' is allowed to split (*note Splitting Windows::) an existing window . If it is non-`nil', `display-buffer' tries to the split the largest or least recently used window on the selected frame. (If the selected frame is a minibuffer-only frame, it tries to split a window on another frame instead.) If `pop-up-windows' is nil or the variable ^^^ `pop-up-frames' (see below) is non-`nil', `display-buffer' does not split any window. * Node The Mark Function: handle-shift-selection &optional deactivate This function checks whether the current command was invoked via shift translation (*note shift-translation: Key Sequence Input.), and if so, sets the mark and temporarily activates the region, unless the region is already temporarily activated in this way. If the command was invoked without shift translation, or if the optional argument DEACTIVATE is non-nil, the function deactivates ^^^ the mark. This function is called whenever a command with a `^' character in its `interactive' spec (*note ^: Interactive Codes.) is invoked while `shift-select-mode' (*note Shift Selection: (emacs)Shift Selection.) is non-`nil'. * Node Shell Arguments If SEPARATORS is omitted or nil, it defaults to `"\\s-+"', which ^^^ is a regular expression that matches one or more characters with whitespace syntax (*note Syntax Class Table::). * Node Transaction Queues If the argument DELAY-QUESTION is non-nil, delay sending this ^^^ question until the process has finished replying to any previous questions. This produces more reliable results with some processes. * Node Proceessor Run Time If FORMAT is nil or omitted, it defaults to `"%Y, %D, %H, %M, %z%S"'. ^^^ * Node Documentation Tips When a documentation string refers to a Lisp symbol, write it as it would be printed (which usually means in lower case), with single-quotes around it. For example: `lambda'. There are two exceptions: write t and nil without single-quotes. (In this ^ ^^^ manual, we use a different convention, with single-quotes for all symbols.) Actually, those two should probably be written in double quotes, since we are referring to the text, not to the symbols, when talking about "t" and "nil" here. In GNU Emacs 23.0.60.1 (i386-mingw-nt5.1.2600) of 2008-11-08 on LENNART-69DE564 Windowing system distributor `Microsoft Corp.', version 5.1.2600 configured using `configure --with-gcc (3.4) --no-opt --cflags -Ic:/g/include -fno-crossjumping' ------------=_1227585604-26446-1--