bug#72121: [PATCH] Replace (non-)nil with (non-)@code{nil} and fix quoting in texinfo

bug#72121: [PATCH] Replace (non-)nil with (non-)@code{nil} and fix quoting in texinfo

[Steven Allen via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 282 bytes --]


These patches fix some minor stylistic issues that came up in bug#71969.

- The first one replace instances of 'non-nil' with 'non-@code{nil}' and
  'nil' with '@code{nil}' per the style docs.
- The second one is a drive-by fix to change a few quoted symbols to
   @code{symbol}.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Replace-non-nil-with-non-code-nil-in-texinfo-files.patch --]
[-- Type: text/x-patch, Size: 7745 bytes --]

From 54abfc270d3bee467802170ad63a00bc8f58cf44 Mon Sep 17 00:00:00 2001
From: Steven Allen <steven@stebalien.com>
Date: Mon, 8 Jul 2024 15:27:14 +0200
Subject: [PATCH 1/2] ; Replace (non-)nil with (non-)@code{nil} in texinfo
 files

* doc/lispref/functions.texi
doc/lispref/keymaps.texi
doc/lispref/strings.texi
doc/misc/cl.texi
doc/misc/dbus.texi
doc/misc/eshell.texi
doc/misc/message.texi
doc/misc/ses.texi
doc/misc/vtable.texi: replace (non-)nil with (non-)@code{nil}
---
 doc/lispref/functions.texi | 2 +-
 doc/lispref/keymaps.texi   | 8 ++++----
 doc/lispref/strings.texi   | 2 +-
 doc/misc/cl.texi           | 8 ++++----
 doc/misc/dbus.texi         | 2 +-
 doc/misc/eshell.texi       | 9 +++++----
 doc/misc/message.texi      | 4 ++--
 doc/misc/ses.texi          | 7 ++++---
 doc/misc/vtable.texi       | 6 +++---
 9 files changed, 25 insertions(+), 23 deletions(-)

diff --git a/doc/lispref/functions.texi b/doc/lispref/functions.texi
index 695e1c3efb5..0cf41072ec3 100644
--- a/doc/lispref/functions.texi
+++ b/doc/lispref/functions.texi
@@ -2089,7 +2089,7 @@ Advising Named Functions
 
 @defmac define-advice symbol (where lambda-list &optional name depth) &rest body
 This macro defines a piece of advice and adds it to the function named
-@var{symbol}.  If @var{name} is non-nil, the advice is named
+@var{symbol}.  If @var{name} is non-@code{nil}, the advice is named
 @code{@var{symbol}@@@var{name}} and installed with the name @var{name}; otherwise,
 the advice is anonymous.  See @code{advice-add} for explanation of
 other arguments.
diff --git a/doc/lispref/keymaps.texi b/doc/lispref/keymaps.texi
index 32aa98d31cb..a67d8da244e 100644
--- a/doc/lispref/keymaps.texi
+++ b/doc/lispref/keymaps.texi
@@ -2603,10 +2603,10 @@ Extended Menu Items
 safely be called at any time.
 
 @item :wrap @var{wrap-p}
-If @var{wrap-p} is non-nil inside a tool bar, the menu item is not
-displayed, but instead causes subsequent items to be displayed on a
-new line.  This is not supported when Emacs uses the GTK+ or Nextstep
-toolkits.
+If @var{wrap-p} is non-@code{nil} inside a tool bar, the menu item is
+not displayed, but instead causes subsequent items to be displayed on
+a new line.  This is not supported when Emacs uses the GTK+ or
+Nextstep toolkits.
 @end table
 
 @node Menu Separators
diff --git a/doc/lispref/strings.texi b/doc/lispref/strings.texi
index e290e2e7a6b..d29665ac19b 100644
--- a/doc/lispref/strings.texi
+++ b/doc/lispref/strings.texi
@@ -1499,7 +1499,7 @@ Case Conversion
 The definition of a word is any sequence of consecutive characters that
 are assigned to the word constituent syntax class in the current syntax
 table (@pxref{Syntax Class Table}); if @code{case-symbols-as-words}
-is non-nil, characters assigned to the symbol constituent syntax
+is non-@code{nil}, characters assigned to the symbol constituent syntax
 class are also considered as word constituent.
 
 When @var{string-or-char} is a character, this function does the same
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index a4a34ae07d6..e893205b40e 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -388,10 +388,10 @@ Printing
 above).  When @var{stream} is a buffer, the ellipsis will be given the
 @code{cl-print-ellipsis} text property.  The value of the text
 property will contain state (including @var{start}) in order to print
-the elided part of @var{object} later.  @var{start} should be nil if
-the whole @var{object} is being elided, otherwise it should be an
-index or other pointer into the internals of @var{object} which can be
-passed to `cl-print-object-contents' at a later time.
+the elided part of @var{object} later.  @var{start} should be
+@code{nil} if the whole @var{object} is being elided, otherwise it
+should be an index or other pointer into the internals of @var{object}
+which can be passed to `cl-print-object-contents' at a later time.
 @end defun
 
 @defvar cl-print-expand-ellipsis-function
diff --git a/doc/misc/dbus.texi b/doc/misc/dbus.texi
index 20d26c80d38..104cde01227 100644
--- a/doc/misc/dbus.texi
+++ b/doc/misc/dbus.texi
@@ -1428,7 +1428,7 @@ Register Objects
 @end table
 
 When @var{service} is not a known name but a unique name, the function
-returns nil.
+returns @code{nil}.
 @end defun
 
 When a name has been chosen, Emacs can offer its own methods, which
diff --git a/doc/misc/eshell.texi b/doc/misc/eshell.texi
index c52b8dd66c9..13dc29afde1 100644
--- a/doc/misc/eshell.texi
+++ b/doc/misc/eshell.texi
@@ -1761,8 +1761,8 @@ Dollars Expansion
 lull you into a false sense of familiarity.
 
 When using command form (@pxref{Invocation}), Eshell will ignore any
-leading nil values, so if @var{foo} is @code{nil}, @samp{$@var{foo}
-echo hello} is equivalent to @samp{echo hello}.
+leading @code{nil} values, so if @var{foo} is @code{nil},
+@samp{$@var{foo} echo hello} is equivalent to @samp{echo hello}.
 
 @table @code
 
@@ -2422,8 +2422,9 @@ Redirection
 @defun eshell-function-target-create output-function &optional close-function
 Create a new virtual target for Eshell that repeatedly calls
 @var{output-function} with the redirected output, as described above.
-If @var{close-function} is non-nil, Eshell will call it when closing the
-target, passing non-@code{nil} if the redirected command succeeded.
+If @var{close-function} is non-@code{nil}, Eshell will call it when
+closing the target, passing non-@code{nil} if the redirected command
+succeeded.
 @end defun
 
 @node Pipelines
diff --git a/doc/misc/message.texi b/doc/misc/message.texi
index d881244c735..6e0e4be7bf5 100644
--- a/doc/misc/message.texi
+++ b/doc/misc/message.texi
@@ -2565,8 +2565,8 @@ Sending Variables
 function, it will be called in the message buffer without any
 arguments, and the corresponding @var{method} will be inserted into
 the message headers as the SMTP Method if the function returns a
-non-@code{nil} value; if @var{method} is nil, the value returned by
-the function @code{cond} is used instead.
+non-@code{nil} value; if @var{method} is @code{nil}, the value
+returned by the function @code{cond} is used instead.
 
 @end table
 
diff --git a/doc/misc/ses.texi b/doc/misc/ses.texi
index 8500a0f08c4..80c7b93aa28 100644
--- a/doc/misc/ses.texi
+++ b/doc/misc/ses.texi
@@ -1060,9 +1060,10 @@ More on cell printing
 
 Special cell values:
 @itemize
-@item nil prints typically the same as "", but allows previous cell to spill over.
-@item '*skip* replaces nil when the previous cell actually does spill over;
-nothing is printed for it.
+@item @code{nil} prints typically the same as "", but allows previous
+cell to spill over.
+@item '*skip* replaces @code{nil} when the previous cell actually does
+spill over; nothing is printed for it.
 @item '*error* indicates that the formula signaled an error instead of
 producing a value: the print cell is filled with hash marks (#).
 @end itemize
diff --git a/doc/misc/vtable.texi b/doc/misc/vtable.texi
index 6003435385f..2e0adfb235a 100644
--- a/doc/misc/vtable.texi
+++ b/doc/misc/vtable.texi
@@ -559,9 +559,9 @@ Interface Functions
 @defun vtable-insert-object table object &optional location before
 Insert @var{object} into @var{table}.  @var{location} should be an
 object in the table, the new object is inserted after this object, or
-before it if @var{before} is non-nil.  If @var{location} is @code{nil},
-@var{object} is appended to @var{table}, or prepended if @var{before} is
-non-@code{nil}.
+before it if @var{before} is non-@code{nil}.  If @var{location} is
+@code{nil}, @var{object} is appended to @var{table}, or prepended if
+@var{before} is non-@code{nil}.
 
 @var{location} can also be an integer, a zero-based index into the
 table.  In this case, @var{object} is inserted at that index.  If the
-- 
2.45.2


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #3: 0002-Replace-quotes-with-code-.-in-texinfo-files.patch --]
[-- Type: text/x-patch, Size: 1570 bytes --]

From 3f2e7c7aee494bd7af2b8db8b347d180cd1c71f1 Mon Sep 17 00:00:00 2001
From: Steven Allen <steven@stebalien.com>
Date: Mon, 15 Jul 2024 07:05:43 -0700
Subject: [PATCH 2/2] ; Replace quotes with @code{...} in texinfo files

* doc/misc/cc-mode.texi
doc/misc/cl.texi: Replace quotes with @code{...}
---
 doc/misc/cc-mode.texi | 4 ++--
 doc/misc/cl.texi      | 3 ++-
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi
index bcbd9faf0c9..ced59c0eee6 100644
--- a/doc/misc/cc-mode.texi
+++ b/doc/misc/cc-mode.texi
@@ -6283,8 +6283,8 @@ List Line-Up
 
 @defun c-lineup-template-args-indented-from-margin
 @findex lineup-template-args-indented-from-margin (c-)
-Indent a template argument line `c-basic-offset' from the left-hand
-margin of the line with the containing <.
+Indent a template argument line @code{c-basic-offset} from the
+left-hand margin of the line with the containing <.
 
 @workswith @code{template-args-cont}.
 @end defun
diff --git a/doc/misc/cl.texi b/doc/misc/cl.texi
index e893205b40e..c3a91f7dab1 100644
--- a/doc/misc/cl.texi
+++ b/doc/misc/cl.texi
@@ -391,7 +391,8 @@ Printing
 the elided part of @var{object} later.  @var{start} should be
 @code{nil} if the whole @var{object} is being elided, otherwise it
 should be an index or other pointer into the internals of @var{object}
-which can be passed to `cl-print-object-contents' at a later time.
+which can be passed to @code{cl-print-object-contents} at a later
+time.
 @end defun
 
 @defvar cl-print-expand-ellipsis-function
-- 
2.45.2

bug#72121: [PATCH] Replace (non-)nil with (non-)@code{nil} and fix quoting in texinfo

[Michael Albinus via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Version: 30.1

Steven Allen via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs@gnu.org> writes:

Hi Steven,

> These patches fix some minor stylistic issues that came up in bug#71969.
>
> - The first one replace instances of 'non-nil' with 'non-@code{nil}' and
>   'nil' with '@code{nil}' per the style docs.
> - The second one is a drive-by fix to change a few quoted symbols to
>    @code{symbol}.

Thanks! I've pushed both patches to the emacs-30 branch, closing the bug.

Best regards, Michael.

bug#72121: [PATCH] Replace (non-)nil with (non-)@code{nil} and fix quoting in texinfo

[Steven Allen via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Thanks!