Subject: CC Mode 5.33.1; Inconsistent formatting in (ccmode) Config Basics
From: "Basil L. Contovounesios" <[email-masked]>
To: [email-masked]
Date: Mon, 04 Mar 2019 23:19:46 +0000
List-Id: <debbugs-submit.debbugs.gnu.org>

Severity: minor

The settings precedence list in '(ccmode) Config Basics' seems to be
misformatted, and is also inconsistent with other itemised lists in the
manual w.r.t. the type of bullet point used.

It seems to be written as a two-column table nested within a list, but
without utilising the second column.  Furthermore, the first item is
indented/bulleted differently to the rest of the items.  Is this
intentional?  If so, why?

Would the following change be suitable for the emacs-26 branch?

diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi
index 1a77a64e01..151b460f7f 100644
--- a/doc/misc/cc-mode.texi
+++ b/doc/misc/cc-mode.texi
@@ -2282,15 +2282,15 @@ Config Basics
 
 If you make conflicting settings in several of these ways, the way
 that takes precedence is the one that appears latest in this list:
-@itemize @w{}
-@item
-@table @asis
+
+@itemize @bullet
 @item Style
-@itemx File Style@footnote{In earlier versions of @ccmode{}, a File Style setting took precedence over any other setting apart from a File Local Variable setting.}
-@itemx Top-level command or ``customization interface''
-@itemx Hook
-@itemx File Local Variable setting
-@end table
+@item File Style@footnote{In earlier versions of @ccmode{}, a File Style
+setting took precedence over any other setting apart from a File Local
+Variable setting.}
+@item Top-level command or ``customization interface''
+@item Hook
+@item File Local Variable setting
 @end itemize
 
 Here is a summary of the different ways of writing your configuration

I also attach three screenshots.  The first two show how the list is
currently rendered in HTML[1] and Info-mode, respectively.  The third
shows the Info-mode rendering following my suggested patch.

[1] https://www.gnu.org/software/emacs/manual/html_node/ccmode/Config-Basics.html

Thanks,

-- 
Basil

Emacs: GNU Emacs 26.1.92 (build 2, x86_64-pc-linux-gnu, X toolkit, Xaw3d scroll bars)
 of 2019-02-26
Package: CC Mode 5.33.1 (C/*l)