branch master updated: Documentation of --OPT vs. --no-OPT

[Gavin D. Smith]

This is an automated email from the git hooks/post-receive script.

gavin pushed a commit to branch master
in repository texinfo.

The following commit(s) were added to refs/heads/master by this push:
     new 91e0c56  Documentation of --OPT vs. --no-OPT
91e0c56 is described below

commit 91e0c56c500f0b6473c01c750c44d1445d372c4d
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Sun Dec 19 14:32:47 2021 +0000

    Documentation of --OPT vs. --no-OPT
    
    * doc/texinfo.texi : Be clearer as to the effects of
    --OPT versus --no-OPT and which does what.  Put --OPT
    first and put options in alphabetical order based on this.
    Report from Dan Jacobson.
---
 ChangeLog        |   9 +++++
 doc/texinfo.texi | 115 ++++++++++++++++++++++++++++---------------------------
 2 files changed, 68 insertions(+), 56 deletions(-)

diff --git a/ChangeLog b/ChangeLog
index 63e8a7f..7b301e0 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,14 @@
 2021-12-19  Gavin Smith  <gavinsmith0123@gmail.com>
 
+       Documentation of --OPT vs. --no-OPT
+
+       * doc/texinfo.texi : Be clearer as to the effects of
+       --OPT versus --no-OPT and which does what.  Put --OPT
+       first and put options in alphabetical order based on this.
+       Report from Dan Jacobson.
+
+2021-12-19  Gavin Smith  <gavinsmith0123@gmail.com>
+
        Fix usage message
 
        * tp/texi2any.pl (makeinfo_help): Say "columns" instead of
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 0d4596b..f26df09 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -15324,17 +15324,6 @@ contains internal whitespace, the first word is taken 
as the variable
 name and the remainder as the value.  For example, @code{-D 'myvar
 someval'} is equivalent to @code{@@set myvar someval}.
 
-@item --disable-encoding
-@itemx --enable-encoding
-@opindex --disable-encoding
-@opindex --enable-encoding
-@vindex ENABLE_ENCODING
-By default, or with @option{--enable-encoding}, output accented and
-special characters in Info and plain text output based on
-@samp{@@documentencoding}.  With @option{--disable-encoding}, 7-bit
-ASCII transliterations are output.  @xref{@code{@@documentencoding}},
-and @ref{Inserting Accents}.
-
 @item --docbook
 @opindex --docbook
 Generate DocBook output (rather than Info).
@@ -15356,6 +15345,18 @@ Generate a TeX DVI file using @command{texi2dvi}, 
rather than Info
 Generate a PDF file using @command{texi2dvi --dvipdf}, rather than
 Info (@pxref{@command{texi2any} Printed Output}).
 
+@item --enable-encoding
+@itemx --disable-encoding
+@opindex --enable-encoding
+@opindex --disable-encoding
+@vindex ENABLE_ENCODING
+By default, or with @option{--enable-encoding}, output accented and
+special characters in Info and plain text output based on
+@samp{@@documentencoding}.  With @option{--disable-encoding}, 7-bit
+ASCII transliterations are output.  @xref{@code{@@documentencoding}},
+and @ref{Inserting Accents}.
+
+
 @item --error-limit=@var{limit}
 @itemx -e @var{limit}
 @opindex --error-limit=@var{limit}
@@ -15448,6 +15449,26 @@ For instance, if @option{--iftex} is given, then 
@samp{@@iftex} and
 @samp{@@tex} blocks will be read, and @samp{@@ifnottex} blocks will be
 ignored.
 
+@item --no-ifdocbook
+@opindex --no-ifdocbook
+@itemx --no-ifhtml
+@opindex --no-ifhtml
+@itemx --no-ifinfo
+@opindex --no-ifinfo
+@itemx --no-ifplaintext
+@opindex --no-ifplaintext
+@itemx --no-iftex
+@opindex --no-iftex
+@itemx --no-ifxml
+@opindex --no-ifxml
+For the given format, do not process @samp{@@if@var{format}} and
+@samp{@@@var{format}} commands, and do process
+@samp{@@ifnot@var{format}}, regardless of the format being output.
+For instance, if @option{--no-ifhtml} is given, then @samp{@@ifhtml}
+and @samp{@@html} blocks will not be read, and @samp{@@ifnothtml}
+blocks will be.
+
+
 @item --info
 @opindex --info
 Generate Info output.  By default, if the output file contains more
@@ -15506,35 +15527,16 @@ links only at the beginning of each file.  If output 
is not split, do
 not include navigation links at the top of each node at all.
 @xref{Generating HTML}.
 
-@item --no-ifdocbook
-@opindex --no-ifdocbook
-@itemx --no-ifhtml
-@opindex --no-ifhtml
-@itemx --no-ifinfo
-@opindex --no-ifinfo
-@itemx --no-ifplaintext
-@opindex --no-ifplaintext
-@itemx --no-iftex
-@opindex --no-iftex
-@itemx --no-ifxml
-@opindex --no-ifxml
-For the given format, do not process @samp{@@if@var{format}} and
-@samp{@@@var{format}} commands, and do process
-@samp{@@ifnot@var{format}}, regardless of the format being output.
-For instance, if @option{--no-ifhtml} is given, then @samp{@@ifhtml}
-and @samp{@@html} blocks will not be read, and @samp{@@ifnothtml}
-blocks will be.
-
-@item --no-node-files
-@itemx --node-files
-@opindex --no-node-files
+@item --node-files
+@itemx --no-node-files
 @opindex --node-files
+@opindex --no-node-files
 @vindex NODE_FILES
-When generating HTML, create redirection files for anchors and any
-nodes not already output with the file name corresponding to the node
-name (@pxref{HTML Xref Node Name Expansion}).  This makes it possible
-for section- and chapter-level cross-manual references to succeed
-(@pxref{HTML Xref Configuration}).
+With @option{--node-files}, when generating HTML, create redirection
+files for anchors and any nodes not already output with the file name
+corresponding to the node name (@pxref{HTML Xref Node Name Expansion}).
+This makes it possible for section- and chapter-level cross-manual
+references to succeed (@pxref{HTML Xref Configuration}).
 
 If the output is split, this is enabled by default.  If the output is
 not split, @option{--node-files} enables the creation of the
@@ -15543,24 +15545,6 @@ redirection files, in addition to the monolithic main 
output file.
 in any case.  This option has no effect with any output format other
 than HTML@.  @xref{Generating HTML}.
 
-@item --no-number-footnotes
-@itemx --number-footnotes
-@opindex --no-number-footnotes
-@vindex NUMBER_FOOTNOTES
-Suppress automatic footnote numbering.  By default, footnotes are
-numbered sequentially within a node, i.e., the current footnote number
-is reset to 1 at the start of each node.
-
-@item --no-number-sections
-@itemx --number-sections
-@opindex --no-number-sections
-@opindex --number-sections
-@vindex NUMBER_SECTIONS
-With @option{--number_sections} (the default), output chapter,
-section, and appendix numbers as in printed manuals.  This works only
-with hierarchically structured manuals.  You should specify
-@code{--no-number-sections} if your manual is not normally structured.
-
 @item --no-validate
 @itemx --no-pointer-validate
 @opindex --no-validate
@@ -15607,6 +15591,25 @@ has the form @samp{(@var{file})}.
 @vindex NO_WARN
 Suppress warning messages (but not error messages).
 
+@item --number-footnotes
+@itemx --no-number-footnotes
+@opindex --no-number-footnotes
+@vindex NUMBER_FOOTNOTES
+With @option{--no-number-footnotes}, suppress automatic footnote
+numbering.  By default, footnotes are numbered sequentially within a node,
+i.e., the current footnote number is reset to 1 at the start of each node.
+
+@item --number-sections
+@itemx --no-number-sections
+@opindex --number-sections
+@opindex --no-number-sections
+@vindex NUMBER_SECTIONS
+With @option{--number_sections} (the default), output chapter,
+section, and appendix numbers as in printed manuals.  This works only
+with hierarchically structured manuals.  You should specify
+@code{--no-number-sections} if your manual is not normally structured.
+
+
 @item --output=@var{file}
 @itemx -o @var{file}
 @opindex --output=@var{file}