GNU bug report logs - #64016
29.0.91; Fix some Texinfo markup in manuals

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 64016 in the body.
You can then email your comments to 64016 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.91; Fix some Texinfo markup in manuals
Date: Mon, 12 Jun 2023 15:09:41 +0100

[Message part 1 (text/plain, inline)]

Severity: minor
Tags: patch

I attach a patch intended for emacs-29, which primarily marks up nil/t
in the manuals as @code (I noticed some instances of @var{nil} while
reading the corresponding text).

WDYT?

Thanks,

-- 
Basil

[0001-Fix-some-Texinfo-markup-in-manuals.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

In GNU Emacs 29.0.91 (build 1, x86_64-pc-linux-gnu, X toolkit, cairo
 version 1.16.0, Xaw3d scroll bars) of 2023-06-12 built on blc
Repository revision: bdb0bc2b4e44a7d40369e10e3de825d58fe46825
Repository branch: wt/emacs-29
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Ubuntu 22.04.2 LTS

Configured using:
 'configure CC=gcc-12 'CFLAGS=-Og -ggdb3' --prefix=/home/bic/.local
 --with-program-suffix=-29 --with-file-notification=yes --with-x
 --with-x-toolkit=lucid'

Configured features:
ACL CAIRO DBUS FREETYPE GIF GLIB GMP GNUTLS GPM GSETTINGS HARFBUZZ JPEG
JSON LCMS2 LIBOTF LIBSELINUX LIBSYSTEMD LIBXML2 M17N_FLT MODULES NOTIFY
INOTIFY PDUMPER PNG RSVG SECCOMP SOUND SQLITE3 THREADS TIFF
TOOLKIT_SCROLL_BARS TREE_SITTER WEBP X11 XAW3D XDBE XIM XINPUT2 XPM
LUCID ZLIB

Important settings:
  value of $LC_MONETARY: en_IE.UTF-8
  value of $LC_NUMERIC: en_IE.UTF-8
  value of $LC_TIME: en_IE.UTF-8
  value of $LANG: en_GB.UTF-8
  value of $XMODIFIERS: @im=ibus
  locale-coding-system: utf-8-unix

Major mode: Lisp Interaction

Minor modes in effect:
  tooltip-mode: t
  global-eldoc-mode: t
  eldoc-mode: t
  show-paren-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  menu-bar-mode: t
  file-name-shadow-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  blink-cursor-mode: t
  line-number-mode: t
  indent-tabs-mode: t
  transient-mark-mode: t
  auto-composition-mode: t
  auto-encryption-mode: t
  auto-compression-mode: t

Load-path shadows:
None found.

Features:
(shadow sort mail-extr emacsbug message mailcap yank-media puny dired
dired-loaddefs rfc822 mml mml-sec password-cache epa derived epg rfc6068
epg-config gnus-util text-property-search time-date subr-x mm-decode
mm-bodies mm-encode mail-parse rfc2231 mailabbrev gmm-utils mailheader
cl-loaddefs cl-lib sendmail rfc2047 rfc2045 ietf-drums mm-util
mail-prsvr mail-utils rmc iso-transl tooltip cconv eldoc paren electric
uniquify ediff-hook vc-hooks lisp-float-type elisp-mode mwheel
term/x-win x-win term/common-win x-dnd tool-bar dnd fontset image
regexp-opt fringe tabulated-list replace newcomment text-mode lisp-mode
prog-mode register page tab-bar menu-bar rfn-eshadow isearch easymenu
timer select scroll-bar mouse jit-lock font-lock syntax font-core
term/tty-colors frame minibuffer nadvice seq simple cl-generic
indonesian philippine cham georgian utf-8-lang misc-lang vietnamese
tibetan thai tai-viet lao korean japanese eucjp-ms cp51932 hebrew greek
romanian slovak czech european ethiopic indian cyrillic chinese
composite emoji-zwj charscript charprop case-table epa-hook
jka-cmpr-hook help abbrev obarray oclosure cl-preloaded button loaddefs
theme-loaddefs faces cus-face macroexp files window text-properties
overlay sha1 md5 base64 format env code-pages mule custom widget keymap
hashtable-print-readable backquote threads dbusbind inotify lcms2
dynamic-setting system-font-setting font-render-setting cairo x-toolkit
xinput2 x multi-tty make-network-process emacs)

Memory information:
((conses 16 36709 7363)
 (symbols 48 5149 0)
 (strings 32 13887 1551)
 (string-bytes 1 379631)
 (vectors 16 9301)
 (vector-slots 8 148632 9511)
 (floats 8 23 25)
 (intervals 56 248 0)
 (buffers 984 10))

Message #8 received at 64016 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: "Basil L. Contovounesios" <contovob <at> tcd.ie>
Cc: 64016 <at> debbugs.gnu.org
Subject: Re: bug#64016: 29.0.91; Fix some Texinfo markup in manuals
Date: Mon, 12 Jun 2023 17:46:23 +0300

> Date: Mon, 12 Jun 2023 15:09:41 +0100
> From:  "Basil L. Contovounesios" via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
> 
> I attach a patch intended for emacs-29, which primarily marks up nil/t
> in the manuals as @code (I noticed some instances of @var{nil} while
> reading the corresponding text).
> 
> WDYT?

LGTM, thanks.  Just a few minor nits:

> --- a/doc/lispref/modes.texi
> +++ b/doc/lispref/modes.texi
> @@ -2921,13 +2921,13 @@ Imenu
>  return non-@code{nil} if the node is a valid node for @var{category},
>  or @code{nil} if not.
>  
> -@var{category} could also be @code{nil}.  In which case the entries
> +@var{category} could also be @code{nil}.  In this case the entries

Here' I'd just convert the period int a comma:

  @var{category} could also be @code{nil}, in which case the entries

Because the change you sggest doesn't make this a better English,
AFAIU.

> --- a/doc/misc/ede.texi
> +++ b/doc/misc/ede.texi
> @@ -1900,7 +1900,7 @@ ede-cpp-root-project
>  @end deffn
>  
>  @deffn Method ede-cpp-root-header-file-p :AFTER proj name
> -Non @code{nil} if in @var{PROJ} the filename @var{NAME} is a header.
> +Non-@code{nil} if in @var{PROJ} the filename @var{NAME} is a header.
                        ^^^^^^^^^^              ^^^^^^^^^^
Argument of @var should always be in lower case.

>  @defvar eudc-ignore-options-file
> -If non-nil, then EUDC ignores @code{eudc-options-file} and warns or
> -issues an error when an attempt is made to use it.  Most users should
> -set this, and keep their EUDC configuration in the main Emacs
> -initialization file instead.  The separate eudc-options file has
> -created confusion for users in the past.
> +If non-@code{nil}, then EUDC ignores @code{eudc-options-file} and
                      ^^^^
That "then" is redundant, and should be dropped.

> @@ -878,11 +878,12 @@ Proc customization variables
>  @item flymake-proc-diagnostic-type-pred
>  A function to classify a diagnostic text as particular type of error.
>  Should be a function taking an error text and returning a diagnostic
> -symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned but
> -there is no such symbol in that table, a warning is assumed.  If nil
> -is returned, an error is assumed.  Can also be a regular expression
> -that should match only warnings.  This variable replaces the old
> -@code{flymake-warning-re} and @code{flymake-warning-predicate}.
> +symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned
> +but there is no such symbol in that table, a warning is assumed.  If
> +@code{nil} is returned, an error is assumed.

How about fixing the abuse of passive voice here, while you are at it?

Message #11 received at 64016 <at> debbugs.gnu.org (full text, mbox):

From: Basil Contovounesios <contovob <at> tcd.ie>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 64016 <at> debbugs.gnu.org
Subject: Re: bug#64016: 29.0.91; Fix some Texinfo markup in manuals
Date: Tue, 13 Jun 2023 15:33:25 +0100

[Message part 1 (text/plain, inline)]

Eli Zaretskii [2023-06-12 10:46 -0400] wrote:

>> Date: Mon, 12 Jun 2023 15:09:41 +0100
>> From:  "Basil L. Contovounesios" via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs <at> gnu.org>
>> 
>> --- a/doc/lispref/modes.texi
>> +++ b/doc/lispref/modes.texi
>> @@ -2921,13 +2921,13 @@ Imenu
>>  return non-@code{nil} if the node is a valid node for @var{category},
>>  or @code{nil} if not.
>>  
>> -@var{category} could also be @code{nil}.  In which case the entries
>> +@var{category} could also be @code{nil}.  In this case the entries
>
> Here' I'd just convert the period int a comma:
>
>   @var{category} could also be @code{nil}, in which case the entries
>
> Because the change you sggest doesn't make this a better English,
> AFAIU.

Done.

>> --- a/doc/misc/ede.texi
>> +++ b/doc/misc/ede.texi
>> @@ -1900,7 +1900,7 @@ ede-cpp-root-project
>>  @end deffn
>>  
>>  @deffn Method ede-cpp-root-header-file-p :AFTER proj name
>> -Non @code{nil} if in @var{PROJ} the filename @var{NAME} is a header.
>> +Non-@code{nil} if in @var{PROJ} the filename @var{NAME} is a header.
>                         ^^^^^^^^^^              ^^^^^^^^^^
> Argument of @var should always be in lower case.

Fixed some nearby ones as well, but I'm leaving the hundreds of
remaining ones in this manual for another audit.

>>  @defvar eudc-ignore-options-file
>> -If non-nil, then EUDC ignores @code{eudc-options-file} and warns or
>> -issues an error when an attempt is made to use it.  Most users should
>> -set this, and keep their EUDC configuration in the main Emacs
>> -initialization file instead.  The separate eudc-options file has
>> -created confusion for users in the past.
>> +If non-@code{nil}, then EUDC ignores @code{eudc-options-file} and
>                       ^^^^
> That "then" is redundant, and should be dropped.

Done.

>> @@ -878,11 +878,12 @@ Proc customization variables
>>  @item flymake-proc-diagnostic-type-pred
>>  A function to classify a diagnostic text as particular type of error.
>>  Should be a function taking an error text and returning a diagnostic
>> -symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned but
>> -there is no such symbol in that table, a warning is assumed.  If nil
>> -is returned, an error is assumed.  Can also be a regular expression
>> -that should match only warnings.  This variable replaces the old
>> -@code{flymake-warning-re} and @code{flymake-warning-predicate}.
>> +symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned
>> +but there is no such symbol in that table, a warning is assumed.  If
>> +@code{nil} is returned, an error is assumed.
>
> How about fixing the abuse of passive voice here, while you are at it?

How's this?

[0001-Fix-some-Texinfo-markup-in-manuals.patch (text/x-diff, attachment)]

[Message part 3 (text/plain, inline)]

Thanks,

-- 
Basil

Message #14 received at 64016 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Basil Contovounesios <contovob <at> tcd.ie>
Cc: 64016 <at> debbugs.gnu.org
Subject: Re: bug#64016: 29.0.91; Fix some Texinfo markup in manuals
Date: Tue, 13 Jun 2023 18:52:23 +0300

> From: Basil Contovounesios <contovob <at> tcd.ie>
> Cc: 64016 <at> debbugs.gnu.org
> Date: Tue, 13 Jun 2023 15:33:25 +0100
> 
> >> @@ -878,11 +878,12 @@ Proc customization variables
> >>  @item flymake-proc-diagnostic-type-pred
> >>  A function to classify a diagnostic text as particular type of error.
> >>  Should be a function taking an error text and returning a diagnostic
> >> -symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned but
> >> -there is no such symbol in that table, a warning is assumed.  If nil
> >> -is returned, an error is assumed.  Can also be a regular expression
> >> -that should match only warnings.  This variable replaces the old
> >> -@code{flymake-warning-re} and @code{flymake-warning-predicate}.
> >> +symbol (@pxref{Flymake error types}).  If non-@code{nil} is returned
> >> +but there is no such symbol in that table, a warning is assumed.  If
> >> +@code{nil} is returned, an error is assumed.
> >
> > How about fixing the abuse of passive voice here, while you are at it?
> 
> How's this?

I only looked at the part which replaced the above hunk, and it's
fine.

Thanks.

Message #19 received at 64016-done <at> debbugs.gnu.org (full text, mbox):

From: Basil Contovounesios <contovob <at> tcd.ie>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 64016-done <at> debbugs.gnu.org
Subject: Re: bug#64016: 29.0.91; Fix some Texinfo markup in manuals
Date: Tue, 13 Jun 2023 17:16:55 +0100

close 64016 29.1
quit

Eli Zaretskii [2023-06-13 11:52 -0400] wrote:

> I only looked at the part which replaced the above hunk, and it's
> fine.

Thanks, pushed and closing.

Fix some Texinfo markup in manuals
0e9307eb2b8 2023-06-13 15:29:06 +0100
https://git.sv.gnu.org/cgit/emacs.git/commit/?id=0e9307eb2b8

-- 
Basil

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.