bug#2975: `texinfo-master-menu' doesn't work.

bug#2975: `texinfo-master-menu' doesn't work.

[Alan Mackenzie]

In Emacs, either 22.3 or a recent CVS version ...
emacs -Q

1.

(i) C-c C-f .../path/to/emacs/doc/misc/cc-mode.texi
(ii) M-g M-g 238          ; the second line of the menu,
                          ; contents "* Overview::"
(ii) C-k C-k              ; Kill this line

(v) Now do C-c C-u m.  This flashes the screen and reports
"Done...completed making master menu.  You may save the buffer.".
However, it hasn't made the master menu - the "* Overview::" line is
still missing.

########################################################################

2.

(i) Kill (remove) the entire master menu from the buffer (between the
  lines "@menu" and "@end menu").
  
(ii) Try to regenerate the master menu with C-c C-u m.  This signals the
puzzling error "Buffer lacks ordinary `Top' menu in which to insert
master".  It is not clear what a "`Top' menu" is, in what respect it is
"ordinary", and in what regard the new master menu is inserted into it.
The existing master menu was not contained within any menu.

#########################################################################

3.

(i) C-c C-f .../path/to/emacs/doc/lispref/elisp.texi
(ii) M-g M-g 108       ; the second line of the menu,
                       ; "* Lisp Data Types:: ...."
(iii) C-k C-k          ; Kill this line

(iv) Now do C-c C-u m.  This doesn't regenerate the master menu.
Instead, it deletes the @detailmenu without restoring the "* Lisp Data
Types::" line.

#########################################################################

Comments:

Neither the doc string for `texinfo-master-menu' nor the texinfo manual
(page "Updating Nodes and Menus") describe other than vaguely what this
command is supposed to do.

The doc string states, accurately, that

    The function removes the detailed part of an already existing master
    menu.

, which though accurate, is puzzling in the extreme; what one wants from
this command is for the detailed bit to be inserted, not deleted.

There is no verb in "texinfo master menu", so one is led by intelligent
guessing to believe that the command does whatever necessary to insert
or update the master menu.  This doesn't happen.

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#2975: `texinfo-master-menu' doesn't work.

[Eli Zaretskii]

> Date: Sun, 12 Apr 2009 21:33:40 +0000
> From: Alan Mackenzie <acm@muc.de>
> 
> In Emacs, either 22.3 or a recent CVS version ...
> emacs -Q
> 
> 1.
> 
> (i) C-c C-f .../path/to/emacs/doc/misc/cc-mode.texi
> (ii) M-g M-g 238          ; the second line of the menu,
>                           ; contents "* Overview::"
> (ii) C-k C-k              ; Kill this line
> 
> (v) Now do C-c C-u m.  This flashes the screen and reports
> "Done...completed making master menu.  You may save the buffer.".
> However, it hasn't made the master menu - the "* Overview::" line is
> still missing.

"C-c C-u m" (texinfo-master-menu) is not supposed to update the menus
in the buffer, including the menu in the Top node, unless you invoke
it with a prefix argument.  If you don't invoke it with a prefix arg,
you need to update the menus yourself, either manually or by running
texinfo-make-menu or texinfo-all-menus-update.  This is because this
command only looks at the _existing_ menus; it does NOT look at the
@node lines to recreate or update any missing/outdated entries in
those menus.

I made this clear in the doc string of texinfo-master-menu.

> 2.
> 
> (i) Kill (remove) the entire master menu from the buffer (between the
>   lines "@menu" and "@end menu").
>   
> (ii) Try to regenerate the master menu with C-c C-u m.  This signals the
> puzzling error "Buffer lacks ordinary `Top' menu in which to insert
> master".  It is not clear what a "`Top' menu" is, in what respect it is
> "ordinary", and in what regard the new master menu is inserted into it.
> The existing master menu was not contained within any menu.

The error is signaled because texinfo-master-menu does not update or
create any menus, see above.  By deleting the menu in the Top node,
you removed the part of the buffer on which texinfo-master-menu
depends for doing its job.  So it barfed.

I changed the error message text so it is hopefully more clear.  It
now says:

  Buffer lacks a menu in its first node; create it, then run me again

> 3.
> 
> (i) C-c C-f .../path/to/emacs/doc/lispref/elisp.texi
> (ii) M-g M-g 108       ; the second line of the menu,
>                        ; "* Lisp Data Types:: ...."
> (iii) C-k C-k          ; Kill this line
> 
> (iv) Now do C-c C-u m.  This doesn't regenerate the master menu.
> Instead, it deletes the @detailmenu without restoring the "* Lisp Data
> Types::" line.

texinfo-master-menu does not support multi-file manuals (which is what
elisp.texi is).  For that, one should use
texinfo-multiple-files-update.  I made that clear in the doc string.

> Neither the doc string for `texinfo-master-menu' nor the texinfo manual
> (page "Updating Nodes and Menus") describe other than vaguely what this
> command is supposed to do.

I made that more clear in the commentary at the beginning of
texnfo-upd.el and in the doc string of texinfo-master-menu.

> The doc string states, accurately, that
> 
>     The function removes the detailed part of an already existing master
>     menu.
> 
> , which though accurate, is puzzling in the extreme; what one wants from
> this command is for the detailed bit to be inserted, not deleted.
> 
> There is no verb in "texinfo master menu", so one is led by intelligent
> guessing to believe that the command does whatever necessary to insert
> or update the master menu.  This doesn't happen.

The crucial part of the doc string was this:

  The master menu includes every entry from all the other menus.

IOW, it only collects entries from existing menus, it does NOT update
the menus.  Admittedly, this crucial piece of information was buried
deep in the doc string.  Hopefully, now it is more clear.

All of the above changes are in revision 106651 on the trunk.

I'm closing this bug report.  Sorry for the long delay in handling it.

bug#2975: `texinfo-master-menu' doesn't work.

[Eli Zaretskii]

> Date: Sun, 11 Dec 2011 17:38:59 +0000
> Cc: bug-texinfo@gnu.org, 2975-done@debbugs.gnu.org
> From: Alan Mackenzie <acm@muc.de>
> 
> > "C-c C-u m" (texinfo-master-menu) is not supposed to update the menus
> > in the buffer, including the menu in the Top node, unless you invoke
> > it with a prefix argument.  If you don't invoke it with a prefix arg,
> > you need to update the menus yourself, either manually or by running
> > texinfo-make-menu or texinfo-all-menus-update.  This is because this
> > command only looks at the _existing_ menus; it does NOT look at the
> > @node lines to recreate or update any missing/outdated entries in
> > those menus.
> 
> > I made this clear in the doc string of texinfo-master-menu.
> 
> Sorry, I find it anything but clear.  I think I've finally twigged what
> C-c C-u m does.  It creates or updates the @detailmenu part of the master
> menu.  Please correct me if I'm wrong about this.  However, it doesn't
> create/update the first part of the master menu, and nor does it create
> the @detailmenu if @menu is missing.

Correct.  And now the current doc string:

    "Make a master menu for a whole Texinfo file.
  Remove pre-existing master menu, if there is one.

  This function supports only single-file manuals.  For multi-file
  manuals, use `texinfo-multiple-files-update'.

  This function creates or updates the @detailmenu section of a
  master menu that follows the Top node.  It replaces any existing
  detailed menu that follows the top node.  The detailed menu
  includes every entry from all the other menus.  By default, the
  existing menus, including the menu in the Top node, are not
  updated according to the buffer contents, so all the menus should
  be updated first using `texinfo-make-menu' or
  `texinfo-all-menus-update', which see.  Alternatively, invoke
  this function with a prefix argument, see below.

  Non-nil, non-numeric argument (C-u prefix, if interactive) means
  first update all existing menus in the buffer (incorporating
  descriptions from pre-existing menus) before it constructs the
  master menu.  If the argument is numeric (e.g., \"C-u 2\"),
  update all existing nodes as well, by calling
  \`texinfo-update-node' on the entire file.  Warning: do NOT
  invoke with a numeric argument if your Texinfo file uses @node
  lines without the `Next', `Previous', `Up' pointers, as the
  result could be an invalid Texinfo file!

  The function removes and recreates the detailed part of an already
  existing master menu.  This action assumes that the pre-existing
  master menu uses the standard `texinfo-master-menu-header' for the
  detailed menu.

  The master menu has the following format, which is adapted from the
  recommendation in the Texinfo Manual:

     * The first part contains the major nodes in the Texinfo file: the
       nodes for the chapters, chapter-like sections, and the major
       appendices.  This includes the indices, so long as they are in
       chapter-like sections, such as unnumbered sections.

     * The second and subsequent parts contain a listing of the other,
       lower level menus, in order.  This way, an inquirer can go
       directly to a particular node if he or she is searching for
       specific information.

  Each of the menus in the detailed node listing is introduced by the
  title of the section containing the menu.

> @dfn{master menu} is on page "Master Menu Parts" in the Texinfo manual.
> In particular,
> 
>     A master menu is enclosed in `@menu' and `@end menu' commands ...

I didn't do anything with the Texinfo manual, mind you.  This bug
report is about Emacs.

> Why doesn't C-c C-u m update the entire master menu?  I mean, what use is
> the current command, as opposed to the one I want?

I'm just guessing here, but my guess is that you sometimes may wish to
create or update only the @detailmenu.  After all, texinfo-make-menu
is the way to create/update any menu, including the top-level menu, if
you don't have one or if it is outdated.

> > > 2.
> 
> > > (i) Kill (remove) the entire master menu from the buffer (between the
> > >   lines "@menu" and "@end menu").
> 
> > > (ii) Try to regenerate the master menu with C-c C-u m.  This signals the
> > > puzzling error "Buffer lacks ordinary `Top' menu in which to insert
> > > master".  It is not clear what a "`Top' menu" is, in what respect it is
> > > "ordinary", and in what regard the new master menu is inserted into it.
> > > The existing master menu was not contained within any menu.
> 
> > The error is signaled because texinfo-master-menu does not update or
> > create any menus, see above.
> 
> t-m-m's doc string states explicitly that it DOES make a master menu.

It sounds like your notion of "master menu" is different from what the
command means, see above.

> > IOW, it only collects entries from existing menus, it does NOT update
> > the menus.  Admittedly, this crucial piece of information was buried
> > deep in the doc string.  Hopefully, now it is more clear.
> 
> I think I've understood now, but I don't think it's at all clear.

Feel free to suggest specific improvements or point out specific
parts of the doc string that need improvement.

bug#2975: `texinfo-master-menu' doesn't work.

[Alan Mackenzie]

Hello again, Eli.

On Sun, Dec 11, 2011 at 08:18:06PM +0200, Eli Zaretskii wrote:
> > Date: Sun, 11 Dec 2011 17:38:59 +0000
> > Cc: bug-texinfo@gnu.org, 2975-done@debbugs.gnu.org
> > From: Alan Mackenzie <acm@muc.de>

> > > "C-c C-u m" (texinfo-master-menu) is not supposed to update the menus
> > > in the buffer, including the menu in the Top node, unless you invoke
> > > it with a prefix argument.  If you don't invoke it with a prefix arg,
> > > you need to update the menus yourself, either manually or by running
> > > texinfo-make-menu or texinfo-all-menus-update.  This is because this
> > > command only looks at the _existing_ menus; it does NOT look at the
> > > @node lines to recreate or update any missing/outdated entries in
> > > those menus.

> > > I made this clear in the doc string of texinfo-master-menu.

Although I updated and rebuilt Emacs yesterday, I got the old doc string,
so please forgive my reply.  The way I got this doc string was:

    emacs -Q
    M-x load-library texinfo
    C-h f texinfo-master-menu

.  It turns out that the doc string is duplicated in texinfo.el in an
autoload form.  ;-(

[ .... ]

> And now the current doc string:

>     "Make a master menu for a whole Texinfo file.
>   Remove pre-existing master menu, if there is one.

>   This function supports only single-file manuals.  For multi-file
>   manuals, use `texinfo-multiple-files-update'.

>   This function creates or updates the @detailmenu section of a
>   master menu that follows the Top node.  It replaces any existing
>   detailed menu that follows the top node.  The detailed menu
>   includes every entry from all the other menus.  By default, the
>   existing menus, including the menu in the Top node, are not
>   updated according to the buffer contents, so all the menus should
>   be updated first using `texinfo-make-menu' or
>   `texinfo-all-menus-update', which see.  Alternatively, invoke
>   this function with a prefix argument, see below.

>   Non-nil, non-numeric argument (C-u prefix, if interactive) means
>   first update all existing menus in the buffer (incorporating
>   descriptions from pre-existing menus) before it constructs the

Correction: "before CONSTRUCTING the master menu."

>   master menu.  If the argument is numeric (e.g., \"C-u 2\"),
>   update all existing nodes as well, by calling
>   \`texinfo-update-node' on the entire file.  Warning: do NOT
>   invoke with a numeric argument if your Texinfo file uses @node
>   lines without the `Next', `Previous', `Up' pointers, as the
>   result could be an invalid Texinfo file!

>   The function removes and recreates the detailed part of an already
>   existing master menu.  This action assumes that the pre-existing
>   master menu uses the standard `texinfo-master-menu-header' for the
>   detailed menu.

>   The master menu has the following format, which is adapted from the
>   recommendation in the Texinfo Manual:

>      * The first part contains the major nodes in the Texinfo file: the
>        nodes for the chapters, chapter-like sections, and the major
>        appendices.  This includes the indices, so long as they are in
>        chapter-like sections, such as unnumbered sections.

>      * The second and subsequent parts contain a listing of the other,
>        lower level menus, in order.  This way, an inquirer can go
>        directly to a particular node if he or she is searching for
>        specific information.

>   Each of the menus in the detailed node listing is introduced by the
>   title of the section containing the menu.

> > @dfn{master menu} is on page "Master Menu Parts" in the Texinfo manual.
> > In particular,

> >     A master menu is enclosed in `@menu' and `@end menu' commands ...

> I didn't do anything with the Texinfo manual, mind you.  This bug
> report is about Emacs.

:-)  There's an inconsistency there.  The manual is Karl B's thing, isn't
it?

> > Why doesn't C-c C-u m update the entire master menu?  I mean, what use is
> > the current command, as opposed to the one I want?

> I'm just guessing here, but my guess is that you sometimes may wish to
> create or update only the @detailmenu.  After all, texinfo-make-menu
> is the way to create/update any menu, including the top-level menu, if
> you don't have one or if it is outdated.

[ .... ]

> > t-m-m's doc string states explicitly that it DOES make a master menu.

> It sounds like your notion of "master menu" is different from what the
> command means, see above.

THAT is the thing that's caused this discussion.  I have conceptualised
"master menu" as the entire hierarchical thing starting at Top.  You have
seen a separate menu in each node (including Top) and then @detailedmenu
as a summary, a distinct entity.  Now everything is clear.

-- 
Alan Mackenzie (Nuremberg, Germany).

bug#2975: `texinfo-master-menu' doesn't work.

[Eli Zaretskii]

> Date: Mon, 12 Dec 2011 12:25:44 +0000
> Cc: 2975@debbugs.gnu.org
> From: Alan Mackenzie <acm@muc.de>
> 
> > It sounds like your notion of "master menu" is different from what the
> > command means, see above.
> 
> THAT is the thing that's caused this discussion.  I have conceptualised
> "master menu" as the entire hierarchical thing starting at Top.  You have
> seen a separate menu in each node (including Top) and then @detailedmenu
> as a summary, a distinct entity.  Now everything is clear.

Does the new doc string make this clear, or do you still see place for
improvement?

Thanks.

texinfo-master-menu and emacs.texi

[Roland Winkler]

I am trying to write a more up-to-date info manual for BBDB.
However, I am not yet familiar with the subtleties of how to set up
an info manual. For a more advanced example for how this can be done
I looked into emacs.texi.

The texinfo manual says about "Updating Nodes and Menus"

  If you do not use the updating commands, you need to write menus
  and node pointers by hand, which is a tedious task.

The emacs command texinfo-master-menu (used with a prefix arg) is
supposed to do that; according to the doc string it updates all
existing nodes and menus. Yet when I run this command on emacs.texi,
this brings emacs.texi into a format that makes makeinfo rather
unhappy. What is going on here? Is emacs.texi too advanced for
emacs' texinfo mode so that nodes need to be updated by hand? Or is
there a more sophisticated way of updating nodes in an automated
fashion that works even for something like emacs.texi?

What kind of constructs in emacs.texi go beyond the capabilities of
texinfo-master-menu so that (at least in the beginning) I might want
to avoid them?

Any hints are appreciated.

Roland

Re: texinfo-master-menu and emacs.texi

[Leo]

On 2011-12-07 17:20 +0800, Roland Winkler wrote:
> The texinfo manual says about "Updating Nodes and Menus"
>
>   If you do not use the updating commands, you need to write menus
>   and node pointers by hand, which is a tedious task.

I think AUCTeX has a texinfo mode that can update this for you.

Leo

Re: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Wed, Dec 07 2011, Leo wrote:
> I think AUCTeX has a texinfo mode that can update this for you.

Auctex calls the very same command texinfo-all-menus-update from GNU
Emacs' texnfo-upd.el.

Roland

Re: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Wed, 7 Dec 2011 03:20:08 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> 
> The texinfo manual says about "Updating Nodes and Menus"
> 
>   If you do not use the updating commands, you need to write menus
>   and node pointers by hand, which is a tedious task.
> 
> The emacs command texinfo-master-menu (used with a prefix arg) is
> supposed to do that; according to the doc string it updates all
> existing nodes and menus. Yet when I run this command on emacs.texi,
> this brings emacs.texi into a format that makes makeinfo rather
> unhappy. What is going on here?

It would help if you'd show the error messages from the "unhappy"
makeinfo.  As things are, I need to guess, and my guess is that
texinfo-master-menu does not support multi-file manuals.  It only
works on a single buffer.  At least I don't see in its code any hints
that it does have the ability to gather all the multiple files which
constitute the ELisp manual, using the @include directives or some
such.

My advice is to use texinfo-update-node and texinfo-make-menu on
individual nodes or groups of nodes as you go; that's what I do.
Unless your manual is on a single large file, in which case I expect
texinfo-master-menu to just work.

> Or is there a more sophisticated way of updating nodes in an
> automated fashion that works even for something like emacs.texi?

What I advise above is AFAIK the "more sophisticated way".

Re: texinfo-master-menu and emacs.texi

[Roland Winkler]

[-- Attachment #1: message body text --]
[-- Type: text/plain, Size: 1347 bytes --]

On Wed Dec 7 2011 Eli Zaretskii wrote:
> It would help if you'd show the error messages from the "unhappy"
> makeinfo.  

Thanks for your help. I attached the diffs between the original
emacs.texi and what texinfo-master-menu made out of it
(diff-emacs.texi.txt). Also, I attached a file makinfo-output.txt
with the makeinfo output for the modified file emacs.texi

> As things are, I need to guess, and my guess is that
> texinfo-master-menu does not support multi-file manuals. It only
> works on a single buffer. At least I don't see in its code any
> hints that it does have the ability to gather all the multiple
> files which constitute the ELisp manual, using the @include
> directives or some such.

If this was the case it would help if it was documented somewhere.

> My advice is to use texinfo-update-node and texinfo-make-menu on
> individual nodes or groups of nodes as you go; that's what I do.
> Unless your manual is on a single large file, in which case I expect
> texinfo-master-menu to just work.

While my info manual is still very short, it contains already three
files as I am including the files gpl.texi and doclicense.texi. It
would be unfortunate if the inclusion of these files made it already
impossible to use texinfo-master-menu.

> What I advise above is AFAIK the "more sophisticated way".

Thanks again,

Roland


[-- Attachment #2: diff-emacs.texi.txt --]
[-- Type: text/plain, Size: 55895 bytes --]

--- emacs.texi~	2011-12-07 08:00:34.000000000 -0600
+++ emacs.texi	2011-12-07 08:00:49.000000000 -0600
@@ -133,1084 +133,27 @@
 @end ignore
 
 @menu
-* Distrib::             How to get the latest Emacs distribution.
-* Intro::               An introduction to Emacs concepts.
+* Distrib::                     How to get the latest Emacs distribution.
+* Intro::                       An introduction to Emacs concepts.
 @c Note that in the printed manual, the glossary and indices come last.
-* Glossary::            Terms used in this manual.
-
-Indexes (each index contains a large menu)
-* Key Index::           An item for each standard Emacs key sequence.
-* Option Index::        An item for every command-line option.
-* Command Index::       An item for each command name.
-* Variable Index::      An item for each documented variable.
-* Concept Index::       An item for each concept.
-
-* Acknowledgments::     Major contributors to GNU Emacs.
-
-Important General Concepts
-* Screen::              How to interpret what you see on the screen.
-* User Input::          Kinds of input events (characters, buttons,
-                          function keys).
-* Keys::                Key sequences: what you type to request one
-                          editing action.
-* Commands::            Named functions run by key sequences to do editing.
-* Entering Emacs::      Starting Emacs from the shell.
-* Exiting::             Stopping or killing Emacs.
-
-Fundamental Editing Commands
-* Basic::               The most basic editing commands.
-* Minibuffer::          Entering arguments that are prompted for.
-* M-x::                 Invoking commands by their names.
-* Help::                Commands for asking Emacs about its commands.
-
-Important Text-Changing Commands
-* Mark::                The mark: how to delimit a "region" of text.
-* Killing::             Killing (cutting) text.
-* Yanking::             Recovering killed text.  Moving text. (Pasting.)
-* Cut and Paste::       Clipboard and selections on graphical displays.
-* Accumulating Text::   Other ways of copying text.
-* Rectangles::          Operating on text in rectangular areas.
-* CUA Bindings::        Using @kbd{C-x}, @kbd{C-c}, @kbd{C-v} to kill and yank.
-* Registers::           Saving a text string or a location in the buffer.
-* Display::             Controlling what text is displayed.
-* Search::              Finding or replacing occurrences of a string.
-* Fixit::               Commands especially useful for fixing typos.
-* Keyboard Macros::     Recording a sequence of keystrokes to be replayed.
-
-Major Structures of Emacs
-* Files::               All about handling files.
-* Buffers::             Multiple buffers; editing several files at once.
-* Windows::             Viewing two pieces of text at once.
-* Frames::              Running the same Emacs session in multiple X windows.
-* International::       Using non-@acronym{ASCII} character sets.
-
-Advanced Features
-* Modes::               Major and minor modes alter Emacs' basic behavior.
-* Indentation::         Editing the white space at the beginnings of lines.
-* Text::                Commands and modes for editing human languages.
-* Programs::            Commands and modes for editing programs.
-* Building::            Compiling, running and debugging programs.
-* Maintaining::         Features for maintaining large programs.
-* Abbrevs::             Defining text abbreviations to reduce
-                          the number of characters you must type.
-* Dired::               Directory and file manager.
-* Calendar/Diary::      Calendar and diary facilities.
-* Sending Mail::        Sending mail in Emacs.
-* Rmail::               Reading mail in Emacs.
-* Gnus::                A flexible mail and news reader.
-* Document View::       Viewing PDF, PS and DVI files.
-* Shell::               Executing shell commands from Emacs.
-* Emacs Server::        Using Emacs as an editing server.
-* Printing::            Printing hardcopies of buffers or regions.
-* Sorting::             Sorting lines, paragraphs or pages within Emacs.
-@ifnottex
-* Picture Mode::        Editing pictures made up of text characters.
-@end ifnottex
-* Editing Binary Files:: Editing binary files with Hexl mode.
-* Saving Emacs Sessions:: Saving Emacs state from one session to the next.
-* Recursive Edit::      Performing edits while "within another command".
-* Emulation::           Emulating some other editors with Emacs.
-* Hyperlinking::        Following links in buffers.
-* Amusements::          Various games and hacks.
-* Packages::            Installing additional features.
-* Customization::       Modifying the behavior of Emacs.
-
-Recovery from Problems
-* Quitting::            Quitting and aborting.
-* Lossage::             What to do if Emacs is hung or malfunctioning.
-* Bugs::                How and when to report a bug.
-* Contributing::        How to contribute improvements to Emacs.
-* Service::             How to get help for your own Emacs needs.
-
-Appendices
-* Copying::             The GNU General Public License gives you permission
+* Copying::                     The GNU General Public License gives you permission
                           to redistribute GNU Emacs on certain terms;
                           it also explains that there is no warranty.
-* GNU Free Documentation License:: The license for this documentation.
-* Emacs Invocation::    Hairy startup options.
-* X Resources::         X resources for customizing Emacs.
-* Antinews::            Information about Emacs version 22.
-* Mac OS / GNUstep::    Using Emacs under Mac OS and GNUstep.
-* Microsoft Windows::   Using Emacs on Microsoft Windows and MS-DOS.
-* Manifesto::           What's GNU?  Gnu's Not Unix!
-
-@c Do NOT modify the following 3 lines!  They must have this form to
-@c be correctly identified by `texinfo-multiple-files-update'.  In
-@c particular, the detailed menu header line MUST be identical to the
-@c value of `texinfo-master-menu-header'.  See texnfo-upd.el.
+* GNU Free Documentation License::  The license for this documentation.
+* Key Index::                   An item for each standard Emacs key sequence.
+* Key Index::                   An item for each standard Emacs key sequence.
+* Option Index::                An item for every command-line option.
+* Command Index::               An item for each command name.
+* Command Index::               An item for each command name.
+* Variable Index::              An item for each documented variable.
+* Concept Index::               An item for each concept.
 
 @detailmenu
  --- The Detailed Node Listing ---
- ---------------------------------
-
-Here are some other nodes which are really subnodes of the ones
-already listed, mentioned here so you can get to them in one step:
-
-The Organization of the Screen
-
-* Point::               The place in the text where editing commands operate.
-* Echo Area::           Short messages appear at the bottom of the screen.
-* Mode Line::           Interpreting the mode line.
-* Menu Bar::            How to use the menu bar.
-
-Basic Editing Commands
-
-* Inserting Text::      Inserting text by simply typing it.
-* Moving Point::        Moving the cursor to the place where you want to
-                        change something.
-* Erasing::             Deleting and killing text.
-* Basic Undo::          Undoing recent changes in the text.
-* Basic Files::         Visiting, creating, and saving files.
-* Basic Help::          Asking what a character does.
-* Blank Lines::         Making and deleting blank lines.
-* Continuation Lines::  How Emacs displays lines too wide for the screen.
-* Position Info::       What page, line, row, or column is point on?
-* Arguments::           Numeric arguments for repeating a command N times.
-* Repeating::           Repeating the previous command quickly.
-
-The Minibuffer
-
-* Minibuffer File::     Entering file names with the minibuffer.
-* Minibuffer Edit::     How to edit in the minibuffer.
-* Completion::          An abbreviation facility for minibuffer input.
-* Minibuffer History::  Reusing recent minibuffer arguments.
-* Repetition::          Re-executing commands that used the minibuffer.
-* Passwords::           Entering passwords in the echo area.
-
-Completion
-
-* Completion Example::  Examples of using completion.
-* Completion Commands:: A list of completion commands.
-* Strict Completion::   Different types of completion.
-* Completion Options::  Options for completion.
-
-Help
-
-* Help Summary::        Brief list of all Help commands.
-* Key Help::            Asking what a key does in Emacs.
-* Name Help::           Asking about a command, variable or function name.
-* Apropos::             Asking what pertains to a given topic.
-* Help Mode::           Special features of Help mode and Help buffers.
-* Library Keywords::    Finding Lisp libraries by keywords (topics).
-* Language Help::       Help relating to international language support.
-* Misc Help::           Other help commands.
-* Help Files::          Commands to display pre-written help files.
-* Help Echo::           Help on active text and tooltips (`balloon help').
-
-The Mark and the Region
-
-* Setting Mark::        Commands to set the mark.
-* Marking Objects::     Commands to put region around textual units.
-* Using Region::        Summary of ways to operate on contents of the region.
-* Mark Ring::           Previous mark positions saved so you can go back there.
-* Global Mark Ring::    Previous mark positions in various buffers.
-* Shift Selection::     Using shifted cursor motion keys.
-* Persistent Mark::     Keeping the mark active all the time.
-
-Killing and Moving Text
-
-* Deletion::            Commands for deleting small amounts of text and
-                          blank areas.
-* Killing by Lines::    How to kill entire lines of text at one time.
-* Other Kill Commands:: Commands to kill large regions of text and
-                          syntactic units such as words and sentences.
-* Kill Options::        Options that affect killing.
-
-Yanking
-
-* Kill Ring::           Where killed text is stored.  Basic yanking.
-* Appending Kills::     Several kills in a row all yank together.
-* Earlier Kills::       Yanking something killed some time ago.
-
-Killing and Yanking on Graphical Displays
-
-* Clipboard::           How Emacs interacts with the system clipboard.
-* Primary Selection::   The temporarily selected text selection.
-* Secondary Selection:: Cutting without altering point and mark.
-
-Registers
-
-* Position Registers::      Saving positions in registers.
-* Text Registers::          Saving text in registers.
-* Rectangle Registers::     Saving rectangles in registers.
-* Configuration Registers:: Saving window configurations in registers.
-* Number Registers::        Numbers in registers.
-* File Registers::          File names in registers.
-* Bookmarks::               Bookmarks are like registers, but persistent.
-
-Controlling the Display
-
-* Scrolling::              Commands to move text up and down in a window.
-* Auto Scrolling::         Redisplay scrolls text automatically when needed.
-* Horizontal Scrolling::   Moving text left and right in a window.
-* Narrowing::              Restricting display and editing to a portion
-                             of the buffer.
-* View Mode::              Viewing read-only buffers.
-* Follow Mode::            Follow mode lets two windows scroll as one.
-* Faces::                  How to change the display style using faces.
-* Standard Faces::         Emacs' predefined faces.
-* Temporary Face Changes:: Commands to temporarily modify the default text face
-* Font Lock::              Minor mode for syntactic highlighting using faces.
-* Highlight Interactively:: Tell Emacs what text to highlight.
-* Fringes::                Enabling or disabling window fringes.
-* Displaying Boundaries::  Displaying top and bottom of the buffer.
-* Useless Whitespace::     Showing possibly-spurious trailing whitespace.
-* Selective Display::      Hiding lines with lots of indentation.
-* Optional Mode Line::     Optional mode line display features.
-* Text Display::           How text characters are normally displayed.
-* Cursor Display::         Features for displaying the cursor.
-* Line Truncation::        Truncating lines to fit the screen width instead
-                             of continuing them to multiple screen lines.
-* Visual Line Mode::       Word wrap and screen line-based editing.
-* Display Custom::         Information on variables for customizing display.
-
-Searching and Replacement
-
-* Incremental Search::     Search happens as you type the string.
-* Nonincremental Search::  Specify entire string and then search.
-* Word Search::            Search for sequence of words.
-* Regexp Search::          Search for match for a regexp.
-* Regexps::                Syntax of regular expressions.
-* Regexp Backslash::       Regular expression constructs starting with `\'.
-* Regexp Example::         A complex regular expression explained.
-* Search Case::            To ignore case while searching, or not.
-* Replace::                Search, and replace some or all matches.
-* Other Repeating Search:: Operating on all matches for some regexp.
-
-Incremental Search
-
-* Basic Isearch::       Basic incremental search commands.
-* Repeat Isearch::      Searching for the same string again.
-* Error in Isearch::    When your string is not found.
-* Special Isearch::     Special input in incremental search.
-* Isearch Yank::        Commands that grab text into the search string
-                          or else edit the search string.
-* Isearch Scroll::      Scrolling during an incremental search.
-* Isearch Minibuffer::  Incremental search of the minibuffer history.
-* Slow Isearch::        Incremental search features for slow terminals.
-
-Replacement Commands
-
-* Unconditional Replace::  Replacing all matches for a string.
-* Regexp Replace::         Replacing all matches for a regexp.
-* Replacement and Case::   How replacements preserve case of letters.
-* Query Replace::          How to use querying.
-
-Commands for Fixing Typos
-
-* Undo::                The Undo commands.
-* Transpose::           Exchanging two characters, words, lines, lists...
-* Fixing Case::         Correcting case of last word entered.
-* Spelling::            Apply spelling checker to a word, or a whole file.
-
-Keyboard Macros
-
-* Basic Keyboard Macro::     Defining and running keyboard macros.
-* Keyboard Macro Ring::      Where previous keyboard macros are saved.
-* Keyboard Macro Counter::   Inserting incrementing numbers in macros.
-* Keyboard Macro Query::     Making keyboard macros do different things each time.
-* Save Keyboard Macro::      Giving keyboard macros names; saving them in files.
-* Edit Keyboard Macro::      Editing keyboard macros.
-* Keyboard Macro Step-Edit:: Interactively executing and editing a keyboard
-                                macro.
-
-File Handling
-
-* File Names::          How to type and edit file-name arguments.
-* Visiting::            Visiting a file prepares Emacs to edit the file.
-* Saving::              Saving makes your changes permanent.
-* Reverting::           Reverting cancels all the changes not saved.
-* Autorevert::          Auto Reverting non-file buffers.
-* Auto Save::           Auto Save periodically protects against loss of data.
-* File Aliases::        Handling multiple names for one file.
-* Directories::         Creating, deleting, and listing file directories.
-* Comparing Files::     Finding where two files differ.
-* Diff Mode::           Mode for editing file differences.
-* Misc File Ops::       Other things you can do on files.
-* Compressed Files::    Accessing compressed files.
-* File Archives::       Operating on tar, zip, jar etc. archive files.
-* Remote Files::        Accessing files on other sites.
-* Quoted File Names::   Quoting special characters in file names.
-* File Name Cache::     Completion against a list of files you often use.
-* File Conveniences::   Convenience Features for Finding Files.
-* Filesets::            Handling sets of files.
-
-Saving Files
-
-* Save Commands::       Commands for saving files.
-* Backup::              How Emacs saves the old version of your file.
-* Customize Save::      Customizing the saving of files.
-* Interlocking::        How Emacs protects against simultaneous editing
-                          of one file by two users.
-* File Shadowing::      Copying files to "shadows" automatically.
-* Time Stamps::         Emacs can update time stamps on saved files.
-
-Backup Files
-
-* Backup Names::        How backup files are named.
-* Backup Deletion::     Emacs deletes excess numbered backups.
-* Backup Copying::      Backups can be made by copying or renaming.
-
-Auto Reverting Non-File Buffers
-
-* Auto Reverting the Buffer Menu:: Auto Revert of the Buffer Menu.
-* Auto Reverting Dired::           Auto Revert of Dired buffers.
-* Supporting additional buffers::  How to add more Auto Revert support.
-
-Auto-Saving: Protection Against Disasters
-
-* Auto Save Files::     The file where auto-saved changes are
-                          actually made until you save the file.
-* Auto Save Control::   Controlling when and how often to auto-save.
-* Recover::             Recovering text from auto-save files.
-
-Using Multiple Buffers
-
-* Select Buffer::       Creating a new buffer or reselecting an old one.
-* List Buffers::        Getting a list of buffers that exist.
-* Misc Buffer::         Renaming; changing read-onlyness; copying text.
-* Kill Buffer::         Killing buffers you no longer need.
-* Several Buffers::     How to go through the list of all buffers
-                          and operate variously on several of them.
-* Indirect Buffers::    An indirect buffer shares the text of another buffer.
-* Buffer Convenience::  Convenience and customization features for
-                          buffer handling.
-
-Convenience Features and Customization of Buffer Handling
-
-* Uniquify::            Making buffer names unique with directory parts.
-* Iswitchb::            Switching between buffers with substrings.
-* Buffer Menus::        Configurable buffer menu.
-
-Multiple Windows
-
-* Basic Window::        Introduction to Emacs windows.
-* Split Window::        New windows are made by splitting existing windows.
-* Other Window::        Moving to another window or doing something to it.
-* Pop Up Window::       Finding a file or buffer in another window.
-* Force Same Window::   Forcing certain buffers to appear in the selected
-                          window rather than in another window.
-* Change Window::       Deleting windows and changing their sizes.
-* Window Convenience::  Convenience functions for window handling.
-
-Frames and Graphical Displays
-
-* Mouse Commands::      Moving, cutting, and pasting, with the mouse.
-* Word and Line Mouse:: Mouse commands for selecting whole words or lines.
-* Mouse References::    Using the mouse to select an item from a list.
-* Menu Mouse Clicks::   Mouse clicks that bring up menus.
-* Mode Line Mouse::     Mouse clicks on the mode line.
-* Creating Frames::     Creating additional Emacs frames with various contents.
-* Frame Commands::      Iconifying, deleting, and switching frames.
-* Fonts::               Changing the frame font.
-* Speedbar::            How to make and use a speedbar frame.
-* Multiple Displays::   How one Emacs job can talk to several displays.
-* Special Buffer Frames::  You can make certain buffers have their own frames.
-* Frame Parameters::    Changing the colors and other modes of frames.
-* Scroll Bars::         How to enable and disable scroll bars; how to use them.
-* Wheeled Mice::        Using mouse wheels for scrolling.
-* Drag and Drop::       Using drag and drop to open files and insert text.
-* Menu Bars::           Enabling and disabling the menu bar.
-* Tool Bars::           Enabling and disabling the tool bar.
-* Dialog Boxes::        Controlling use of dialog boxes.
-* Tooltips::            Displaying information at the current mouse position.
-* Mouse Avoidance::     Moving the mouse pointer out of the way.
-* Non-Window Terminals::  Multiple frames on terminals that show only one.
-* Text-Only Mouse::     Using the mouse in text-only terminals.
-
-International Character Set Support
-
-* International Chars::     Basic concepts of multibyte characters.
-* Enabling Multibyte::      Controlling whether to use multibyte characters.
-* Language Environments::   Setting things up for the language you use.
-* Input Methods::           Entering text characters not on your keyboard.
-* Select Input Method::     Specifying your choice of input methods.
-* Coding Systems::          Character set conversion when you read and
-                              write files, and so on.
-* Recognize Coding::        How Emacs figures out which conversion to use.
-* Specify Coding::          Specifying a file's coding system explicitly.
-* Output Coding::           Choosing coding systems for output.
-* Text Coding::             Choosing conversion to use for file text.
-* Communication Coding::    Coding systems for interprocess communication.
-* File Name Coding::        Coding systems for file @emph{names}.
-* Terminal Coding::         Specifying coding systems for converting
-                              terminal input and output.
-* Fontsets::                Fontsets are collections of fonts
-                              that cover the whole spectrum of characters.
-* Defining Fontsets::       Defining a new fontset.
-* Modifying Fontsets::      Modifying an existing fontset.
-* Undisplayable Characters::When characters don't display.
-* Unibyte Mode::            You can pick one European character set
-                              to use without multibyte characters.
-* Charsets::                How Emacs groups its internal character codes.
-
-Modes
-
-* Major Modes::         Text mode vs. Lisp mode vs. C mode...
-* Minor Modes::         Each minor mode is a feature you can turn on
-                          independently of any others.
-* Choosing Modes::      How modes are chosen when visiting files.
-
-Indentation
-
-* Indentation Commands::  Various commands and techniques for indentation.
-* Tab Stops::             You can set arbitrary "tab stops" and then
-                            indent to the next tab stop when you want to.
-* Just Spaces::           You can request indentation using just spaces.
-
-Commands for Human Languages
-
-* Words::               Moving over and killing words.
-* Sentences::           Moving over and killing sentences.
-* Paragraphs::          Moving over paragraphs.
-* Pages::               Moving over pages.
-* Filling::             Filling or justifying text.
-* Case::                Changing the case of text.
-* Text Mode::           The major modes for editing text files.
-* Outline Mode::        Editing outlines.
-* TeX Mode::            Editing input to the formatter TeX.
-* HTML Mode::           Editing HTML and SGML files.
-* Nroff Mode::          Editing input to the formatter nroff.
-* Formatted Text::      Editing formatted text directly in WYSIWYG fashion.
-* Text Based Tables::   Editing text-based tables in WYSIWYG fashion.
-* Two-Column::          Splitting text columns into separate windows.
-
-Filling Text
-
-* Auto Fill::           Auto Fill mode breaks long lines automatically.
-* Fill Commands::       Commands to refill paragraphs and center lines.
-* Fill Prefix::         Filling paragraphs that are indented
-                          or in a comment, etc.
-* Adaptive Fill::       How Emacs can determine the fill prefix automatically.
-
-Outline Mode
-
-* Outline Format::      What the text of an outline looks like.
-* Outline Motion::      Special commands for moving through
-                          outlines.
-* Outline Visibility::  Commands to control what is visible.
-* Outline Views::       Outlines and multiple views.
-* Foldout::             Folding means zooming in on outlines.
-
-@TeX{} Mode
-
-* TeX Editing::         Special commands for editing in TeX mode.
-* LaTeX Editing::       Additional commands for LaTeX input files.
-* TeX Print::           Commands for printing part of a file with TeX.
-* TeX Misc::            Customization of TeX mode, and related features.
-
-Editing Formatted Text
-
-* Requesting Formatted Text::   Entering and exiting Enriched mode.
-* Hard and Soft Newlines::      There are two different kinds of newlines.
-* Editing Format Info::         How to edit text properties.
-* Format Faces::                Bold, italic, underline, etc.
-* Format Colors::               Changing the color of text.
-* Format Indentation::          Changing the left and right margins.
-* Format Justification::        Centering, setting text flush with the
-                                  left or right margin, etc.
-* Format Properties::           The "special" text properties submenu.
-* Forcing Enriched Mode::       How to force use of Enriched mode.
-
-@c The automatic texinfo menu update inserts some duplicate items here
-@c (faces, colors, indentation, justification, properties), because
-@c they are listed in two menus.  But we already have them above, no
-@c need to list them twice.
-
-Editing Text-based Tables
-
-* Table Definition::    What is a text based table.
-* Table Creation::      How to create a table.
-* Table Recognition::   How to activate and deactivate tables.
-* Cell Commands::       Cell-oriented commands in a table.
-* Cell Justification::  Justifying cell contents.
-* Row Commands::        Manipulating rows of table cell.
-* Column Commands::     Manipulating columns of table cell.
-* Fixed Width Mode::    Fixing cell width.
-* Table Conversion::    Converting between plain text and tables.
-* Measuring Tables::    Analyzing table dimension.
-* Table Misc::          Table miscellany.
-
-Editing Programs
-
-* Program Modes::       Major modes for editing programs.
-* Defuns::              Commands to operate on major top-level parts
-                          of a program.
-* Program Indent::      Adjusting indentation to show the nesting.
-* Parentheses::         Commands that operate on parentheses.
-* Comments::            Inserting, killing, and aligning comments.
-* Documentation::       Getting documentation of functions you plan to call.
-* Hideshow::            Displaying blocks selectively.
-* Symbol Completion::   Completion on symbol names of your program or language.
-* Glasses::             Making identifiersLikeThis more readable.
-* Semantic::            Suite of editing tools based on source code parsing.
-* Misc for Programs::   Other Emacs features useful for editing programs.
-* C Modes::             Special commands of C, C++, Objective-C,
-                          Java, and Pike modes.
-* Asm Mode::            Asm mode and its special features.
-* Fortran::             Fortran mode and its special features.
-
-Top-Level Definitions, or Defuns
-
-* Left Margin Paren::   An open-paren or similar opening delimiter
-                          starts a defun if it is at the left margin.
-* Moving by Defuns::    Commands to move over or mark a major definition.
-* Imenu::               Making buffer indexes as menus.
-* Which Function::      Which Function mode shows which function you are in.
-
-Indentation for Programs
-
-* Basic Indent::        Indenting a single line.
-* Multi-line Indent::   Commands to reindent many lines at once.
-* Lisp Indent::         Specifying how each Lisp function should be indented.
-* C Indent::            Extra features for indenting C and related modes.
-* Custom C Indent::     Controlling indentation style for C and related modes.
-
-Commands for Editing with Parentheses
-
-* Expressions::         Expressions with balanced parentheses.
-* Moving by Parens::    Commands for moving up, down and across
-                          in the structure of parentheses.
-* Matching::            Insertion of a close-delimiter flashes matching open.
-
-Manipulating Comments
-
-* Comment Commands::    Inserting, killing, and aligning comments.
-* Multi-Line Comments:: Commands for adding and editing multi-line comments.
-* Options for Comments::Customizing the comment features.
-
-Documentation Lookup
-
-* Info Lookup::         Looking up library functions and commands
-                          in Info files.
-* Man Page::            Looking up man pages of library functions and commands.
-* Lisp Doc::            Looking up Emacs Lisp functions, etc.
-
-C and Related Modes
-
-* Motion in C::         Commands to move by C statements, etc.
-* Electric C::          Colon and other chars can automatically reindent.
-* Hungry Delete::       A more powerful DEL command.
-* Other C Commands::    Filling comments, viewing expansion of macros,
-                          and other neat features.
-
-Fortran Mode
-
-* Fortran Motion::      Moving point by statements or subprograms.
-* Fortran Indent::      Indentation commands for Fortran.
-* Fortran Comments::    Inserting and aligning comments.
-* Fortran Autofill::    Auto fill support for Fortran.
-* Fortran Columns::     Measuring columns for valid Fortran.
-* Fortran Abbrev::      Built-in abbrevs for Fortran keywords.
-
-Fortran Indentation
-
-* ForIndent Commands::  Commands for indenting and filling Fortran.
-* ForIndent Cont::      How continuation lines indent.
-* ForIndent Num::       How line numbers auto-indent.
-* ForIndent Conv::      Conventions you must obey to avoid trouble.
-* ForIndent Vars::      Variables controlling Fortran indent style.
-
-Compiling and Testing Programs
-
-* Compilation::         Compiling programs in languages other
-                          than Lisp (C, Pascal, etc.).
-* Compilation Mode::    The mode for visiting compiler errors.
-* Compilation Shell::   Customizing your shell properly
-                          for use in the compilation buffer.
-* Grep Searching::      Searching with grep.
-* Flymake::             Finding syntax errors on the fly.
-* Debuggers::           Running symbolic debuggers for non-Lisp programs.
-* Executing Lisp::      Various modes for editing Lisp programs,
-                          with different facilities for running
-                          the Lisp programs.
-* Lisp Libraries::      Creating Lisp programs to run in Emacs.
-* Lisp Eval::           Executing a single Lisp expression in Emacs.
-* Lisp Interaction::    Executing Lisp in an Emacs buffer.
-* External Lisp::       Communicating through Emacs with a separate Lisp.
-
-Running Debuggers Under Emacs
-
-* Starting GUD::        How to start a debugger subprocess.
-* Debugger Operation::  Connection between the debugger and source buffers.
-* Commands of GUD::     Key bindings for common commands.
-* GUD Customization::   Defining your own commands for GUD.
-* GDB Graphical Interface::  An enhanced mode that uses GDB features to
-                          implement a graphical debugging environment through
-                          Emacs.
-
-GDB Graphical Interface
-
-* GDB User Interface Layout::   Control the number of displayed buffers.
-* Source Buffers::              Use the mouse in the fringe/margin to
-                                control your program.
-* Breakpoints Buffer::          A breakpoint control panel.
-* Threads Buffer::              Displays your threads.
-* Stack Buffer::                Select a frame from the call stack.
-* Other GDB Buffers::           Input/output, locals, registers,
-                                assembler, threads and memory buffers.
-* Watch Expressions::           Monitor variable values in the speedbar.
-* Multithreaded Debugging::     Debugging programs with several threads.
-
-Maintaining Large Programs
-
-* Version Control::     Using version control systems.
-* Change Log::          Maintaining a change history for your program.
-* Tags::                Go directly to any function in your program in one
-                          command.  Tags remembers which file it is in.
-* EDE::                 An integrated development environment for Emacs.
-* Emerge::              A convenient way of merging two versions of a program.
-
-Version Control
-
-* Introduction to VC::  How version control works in general.
-* VC Mode Line::        How the mode line shows version control status.
-* Basic VC Editing::    How to edit a file under version control.
-* Log Buffer::          Features available in log entry buffers.
-* Old Revisions::       Examining and comparing old versions.
-* Secondary VC Commands:: The commands used a little less frequently.
-* VC Directory Mode::   Listing files managed by version control.
-* Branches::            Multiple lines of development.
-* Remote Repositories:: Efficient access to remote CVS servers.
-* Revision Tags::       Symbolic names for revisions.
-* Miscellaneous VC::    Various other commands and features of VC.
-* Customizing VC::      Variables that change VC's behavior.
-  
-Introduction to Version Control
-
-* Why Version Control?::    Understanding the problems it addresses.
-* Version Control Systems:: Supported version control back-end systems.
-* VCS Concepts::            Words and concepts related to version control.
-* VCS Merging::             How file conflicts are handled.
-* VCS Changesets::          Changesets in version control.
-* VCS Repositories::        Where version control repositories are stored.
-* Types of Log File::       The VCS log in contrast to the ChangeLog.
-
-Basic Editing under Version Control
-
-* VC With A Merging VCS::  Without locking: default mode for CVS.
-* VC With A Locking VCS::  RCS in its default mode, SCCS, and optionally CVS.
-* Advanced C-x v v::       Advanced features available with a prefix argument.
-
-The Secondary Commands of VC
-
-* Registering::         Putting a file under version control.
-* VC Change Log::       Viewing the VC Change Log.
-* VC Undo::             Canceling changes before or after check-in.
-
-VC Directory Mode
-
-* VC Directory Buffer::   What the buffer looks like and means.
-* VC Directory Commands:: Commands to use in a VC directory buffer.
-
-Multiple Branches of a File
-
-* Switching Branches::    How to get to another existing branch.
-* Creating Branches::     How to start a new branch.
-* Merging::               Transferring changes between branches.
-* Multi-User Branching::  Multiple users working at multiple branches
-                            in parallel.
-
-Remote Repositories
-
-* Version Backups::       Keeping local copies of repository versions.
-* Local Version Control:: Using another version system for local editing.
-
-Revision Tags
-
-* Making Revision Tags::  The tag facilities.
-* Revision Tag Caveats::  Things to be careful of when using tags.
-
-Miscellaneous Commands and Features of VC
-
-* Change Logs and VC::    Generating a change log file from log entries.
-* Renaming and VC::       A command to rename both the source and master
-                            file correctly.
-* Version Headers::       Inserting version control headers into working files.
-
-Customizing VC
-
-* General VC Options::    Options that apply to multiple back ends.
-* RCS and SCCS::          Options for RCS and SCCS.
-* CVS Options::           Options for CVS.
-
-Change Logs
-
-* Change Log Commands:: Commands for editing change log files.
-* Format of ChangeLog:: What the change log file looks like.
-
-Tags Tables
-
-* Tag Syntax::          Tag syntax for various types of code and text files.
-* Create Tags Table::   Creating a tags table with @code{etags}.
-* Etags Regexps::       Create arbitrary tags using regular expressions.
-* Select Tags Table::   How to visit a tags table.
-* Find Tag::            Commands to find the definition of a specific tag.
-* Tags Search::         Using a tags table for searching and replacing.
-* List Tags::           Listing and finding tags defined in a file.
-
-Merging Files with Emerge
-
-* Overview of Emerge::  How to start Emerge.  Basic concepts.
-* Submodes of Emerge::  Fast mode vs. Edit mode.
-                          Skip Prefers mode and Auto Advance mode.
-* State of Difference:: You do the merge by specifying state A or B
-                          for each difference.
-* Merge Commands::      Commands for selecting a difference,
-                          changing states of differences, etc.
-* Exiting Emerge::      What to do when you've finished the merge.
-* Combining in Emerge::     How to keep both alternatives for a difference.
-* Fine Points of Emerge::   Miscellaneous issues.
-
-Abbrevs
-
-* Abbrev Concepts::     Fundamentals of defined abbrevs.
-* Defining Abbrevs::    Defining an abbrev, so it will expand when typed.
-* Expanding Abbrevs::   Controlling expansion: prefixes, canceling expansion.
-* Editing Abbrevs::     Viewing or editing the entire list of defined abbrevs.
-* Saving Abbrevs::      Saving the entire list of abbrevs for another session.
-* Dynamic Abbrevs::     Abbreviations for words already in the buffer.
-* Dabbrev Customization:: What is a word, for dynamic abbrevs.  Case handling.
 
-@ifnottex
-Editing Pictures
-
-* Basic Picture::         Basic concepts and simple commands of Picture Mode.
-* Insert in Picture::     Controlling direction of cursor motion
-                            after "self-inserting" characters.
-* Tabs in Picture::       Various features for tab stops and indentation.
-* Rectangles in Picture:: Clearing and superimposing rectangles.
-@end ifnottex
-
-Dired, the Directory Editor
+Distribution
 
-* Dired Enter::              How to invoke Dired.
-* Dired Navigation::         Special motion commands in the Dired buffer.
-* Dired Deletion::           Deleting files with Dired.
-* Flagging Many Files::      Flagging files based on their names.
-* Dired Visiting::           Other file operations through Dired.
-* Marks vs Flags::           Flagging for deletion vs marking.
-* Operating on Files::       How to copy, rename, print, compress, etc.
-                               either one file or several files.
-* Shell Commands in Dired::  Running a shell command on the marked files.
-* Transforming File Names::  Using patterns to rename multiple files.
-* Comparison in Dired::      Running `diff' by way of Dired.
-* Subdirectories in Dired::  Adding subdirectories to the Dired buffer.
-* Subdir Switches::          Subdirectory switches in Dired.
-* Subdirectory Motion::      Moving across subdirectories, and up and down.
-* Hiding Subdirectories::    Making subdirectories visible or invisible.
-* Dired Updating::           Discarding lines for files of no interest.
-* Dired and Find::           Using `find' to choose the files for Dired.
-* Wdired::                   Operating on files by editing the Dired buffer.
-* Image-Dired::              Viewing image thumbnails in Dired.
-* Misc Dired Features::      Various other features.
-
-The Calendar and the Diary
-
-* Calendar Motion::     Moving through the calendar; selecting a date.
-* Scroll Calendar::     Bringing earlier or later months onto the screen.
-* Counting Days::       How many days are there between two dates?
-* General Calendar::    Exiting or recomputing the calendar.
-* Writing Calendar Files:: Writing calendars to files of various formats.
-* Holidays::            Displaying dates of holidays.
-* Sunrise/Sunset::      Displaying local times of sunrise and sunset.
-* Lunar Phases::        Displaying phases of the moon.
-* Other Calendars::     Converting dates to other calendar systems.
-* Diary::               Displaying events from your diary.
-* Appointments::        Reminders when it's time to do something.
-* Importing Diary::     Converting diary events to/from other formats.
-* Daylight Saving::    How to specify when daylight saving time is active.
-* Time Intervals::      Keeping track of time intervals.
-* Advanced Calendar/Diary Usage:: Advanced Calendar/Diary customization.
-
-Movement in the Calendar
-
-* Calendar Unit Motion::      Moving by days, weeks, months, and years.
-* Move to Beginning or End::  Moving to start/end of weeks, months, and years.
-* Specified Dates::           Moving to the current date or another
-                                specific date.
-
-Conversion To and From Other Calendars
-
-* Calendar Systems::       The calendars Emacs understands
-                             (aside from Gregorian).
-* To Other Calendar::      Converting the selected date to various calendars.
-* From Other Calendar::    Moving to a date specified in another calendar.
-* Mayan Calendar::         Moving to a date specified in a Mayan calendar.
-
-The Diary
-
-* Displaying the Diary::   Viewing diary entries and associated calendar dates.
-* Format of Diary File::   Entering events in your diary.
-* Date Formats::           Various ways you can specify dates.
-* Adding to Diary::        Commands to create diary entries.
-* Special Diary Entries::  Anniversaries, blocks of dates, cyclic entries, etc.
-
-Customizing the Calendar and Diary
-
-* Calendar Customizing::   Calendar layout and hooks.
-* Holiday Customizing::    Defining your own holidays.
-* Date Display Format::    Changing the format.
-* Time Display Format::    Changing the format.
-* Diary Customizing::      Defaults you can set.
-* Non-Gregorian Diary::    Diary entries based on other calendars.
-* Diary Display::          A choice of ways to display the diary.
-* Fancy Diary Display::    Sorting diary entries, using included diary files.
-* Sexp Diary Entries::     More flexible diary entries.
-
-Document Viewing
-
-* Navigation::  Navigation inside DocView buffers.
-* Searching::   Searching inside documents.
-* Slicing::     Specifying which part of pages should be displayed.
-* Conversion::  Influencing and triggering conversion.
-
-Sending Mail
-
-* Mail Format::         Format of the mail being composed.
-* Mail Headers::        Details of some standard mail header fields.
-* Mail Aliases::        Abbreviating and grouping mail addresses.
-* Mail Commands::       Special commands for editing mail being composed.
-* Mail Signature::      Adding a signature to every message.
-* Mail Amusements::     Distracting the NSA; adding fortune messages.
-* Mail Methods::        Using alternative mail-composition methods.
-
-Mail Commands
-
-* Mail Sending::        Commands to send the message.
-* Header Editing::      Commands to move to header fields and edit them.
-* Citing Mail::         Quoting a message you are replying to.
-* Mail Misc::           Attachments, spell checking, etc.
-
-Reading Mail with Rmail
-
-* Rmail Basics::        Basic concepts of Rmail, and simple use.
-* Rmail Scrolling::     Scrolling through a message.
-* Rmail Motion::        Moving to another message.
-* Rmail Deletion::      Deleting and expunging messages.
-* Rmail Inbox::         How mail gets into the Rmail file.
-* Rmail Files::         Using multiple Rmail files.
-* Rmail Output::        Copying message out to files.
-* Rmail Labels::        Classifying messages by labeling them.
-* Rmail Attributes::    Certain standard labels, called attributes.
-* Rmail Reply::         Sending replies to messages you are viewing.
-* Rmail Summary::       Summaries show brief info on many messages.
-* Rmail Sorting::       Sorting messages in Rmail.
-* Rmail Display::       How Rmail displays a message; customization.
-* Rmail Coding::        How Rmail handles decoding character sets.
-* Rmail Editing::       Editing message text and headers in Rmail.
-* Rmail Digest::        Extracting the messages from a digest message.
-* Rmail Rot13::         Reading messages encoded in the rot13 code.
-* Movemail::            More details of fetching new mail.
-* Remote Mailboxes::    Retrieving mail from remote mailboxes.
-* Other Mailbox Formats:: Retrieving mail from local mailboxes in
-                          various formats.
-
-Rmail Summaries
-
-* Rmail Make Summary::       Making various sorts of summaries.
-* Rmail Summary Edit::       Manipulating messages from the summary.
-
-Gnus
-
-* Buffers of Gnus::     The group, summary, and article buffers.
-* Gnus Startup::        What you should know about starting Gnus.
-* Summary of Gnus::     A short description of the basic Gnus commands.
-
-Running Shell Commands from Emacs
-
-* Single Shell::        How to run one shell command and return.
-* Interactive Shell::   Permanent shell taking input via Emacs.
-* Shell Mode::          Special Emacs commands used with permanent shell.
-* Shell Prompts::       Two ways to recognize shell prompts.
-* Shell History::       Repeating previous commands in a shell buffer.
-* Directory Tracking::  Keeping track when the subshell changes directory.
-* Shell Options::       Options for customizing Shell mode.
-* Terminal emulator::   An Emacs window as a terminal emulator.
-* Term Mode::           Special Emacs commands used in Term mode.
-* Paging in Term::      Paging in the terminal emulator.
-* Remote Host::         Connecting to another computer.
-* Serial Terminal::     Connecting to a serial port.
-
-Shell Command History
-
-* Shell Ring::           Fetching commands from the history list.
-* Shell History Copying::Moving to a command and then copying it.
-* History References::   Expanding @samp{!}-style history references.
-
-Using Emacs as a Server
-
-* Invoking emacsclient:: Connecting to the Emacs server.
-* emacsclient Options::  Emacs client startup options.
-
-Printing Hard Copies
-
-* PostScript::           Printing buffers or regions as PostScript.
-* PostScript Variables:: Customizing the PostScript printing commands.
-* Printing Package::     An optional advanced printing interface.
-
-Hyperlinking and Navigation Features
-
-* Browse-URL::          Following URLs.
-* Goto Address mode::   Activating URLs.
-* FFAP::                Finding files etc. at point.
-
-Emacs Lisp Packages
-
-* Package Menu::         Buffer for viewing and managing packages.
-* Package Installation:: Options for package installation.
-* Package Files::        Where packages are installed.
-
-Customization
-
-* Easy Customization::  Convenient way to browse and change settings.
-* Variables::           Many Emacs commands examine Emacs variables
-                          to decide what to do; by setting variables,
-                          you can control their functioning.
-* Key Bindings::        Keymaps say what command each key runs.
-                          By changing them, you can "redefine" keys.
-* Init File::           How to write common customizations in the
-                          @file{.emacs} file.
-
-Easy Customization Interface
-
-* Customization Groups::     How settings are classified in a structure.
-* Browsing Custom::          Browsing and searching for settings.
-* Changing a Variable::      How to edit an option's value and set the option.
-* Saving Customizations::    Specifying the file for saving customizations.
-* Face Customization::       How to edit the attributes of a face.
-* Specific Customization::   Making a customization buffer for specific
-                                variables, faces, or groups.
-* Custom Themes::            How to define collections of customized options
-                                that can be loaded and unloaded together.
-
-Variables
-
-* Examining::           Examining or setting one variable's value.
-* Hooks::               Hook variables let you specify programs for parts
-                          of Emacs to run on particular occasions.
-* Locals::              Per-buffer values of variables.
-* File Variables::      How files can specify variable values.
-* Directory Variables:: How variable values can be specified by directory.
-
-Local Variables in Files
-
-* Specifying File Variables:: Specifying file local variables.
-* Safe File Variables::       Making sure file local variables are safe.
-
-Customizing Key Bindings
-
-* Keymaps::             Generalities.  The global keymap.
-* Prefix Keymaps::      Keymaps for prefix keys.
-* Local Keymaps::       Major and minor modes have their own keymaps.
-* Minibuffer Maps::     The minibuffer uses its own local keymaps.
-* Rebinding::           How to redefine one key's meaning conveniently.
-* Init Rebinding::      Rebinding keys with your init file, @file{.emacs}.
-* Modifier Keys::       Using modifier keys in key bindings.
-* Function Keys::       Rebinding terminal function keys.
-* Named ASCII Chars::   Distinguishing @key{TAB} from @kbd{C-i}, and so on.
-* Mouse Buttons::       Rebinding mouse buttons in Emacs.
-* Disabling::           Disabling a command means confirmation is required
-                          before it can be executed.  This is done to protect
-                          beginners from surprises.
-
-The Init File, @file{~/.emacs}
-
-* Init Syntax::         Syntax of constants in Emacs Lisp.
-* Init Examples::       How to do some things with an init file.
-* Terminal Init::       Each terminal type can have an init file.
-* Find Init::           How Emacs finds the init file.
-* Init Non-ASCII::      Using non-@acronym{ASCII} characters in an init file.
-
-Dealing with Emacs Trouble
-
-* DEL Does Not Delete:: What to do if @key{DEL} doesn't delete.
-* Stuck Recursive::     `[...]' in mode line around the parentheses.
-* Screen Garbled::      Garbage on the screen.
-* Text Garbled::        Garbage in the text.
-* Memory Full::         How to cope when you run out of memory.
-* After a Crash::       Recovering editing in an Emacs session that crashed.
-* Emergency Escape::    Emergency escape---
-                          What to do if Emacs stops responding.
-* Total Frustration::   When you are at your wits' end.
-
-Reporting Bugs
-
-* Known Problems::      How to read about known problems and bugs.
-* Bug Criteria::        Have you really found a bug?
-* Understanding Bug Reporting:: How to report a bug effectively.
-* Checklist::           Steps to follow for a good bug report.
-* Sending Patches::     How to send a patch for GNU Emacs.
-
-Command Line Arguments for Emacs Invocation
-
-* Action Arguments::    Arguments to visit files, load libraries,
-                          and call functions.
-* Initial Options::     Arguments that take effect while starting Emacs.
-* Command Example::     Examples of using command line arguments.
-* Resume Arguments::    Specifying arguments when you resume a running Emacs.
-* Environment::         Environment variables that Emacs uses.
-* Display X::           Changing the default display and using remote login.
-* Font X::              Choosing a font for text, under X.
-* Colors::              Choosing display colors.
-* Window Size X::       Start-up window size, under X.
-* Borders X::           Internal and external borders, under X.
-* Title X::             Specifying the initial frame's title.
-* Icons X::             Choosing what sort of icon to use, under X.
-* Misc X::              Other display options.
-
-Environment Variables
-
-* General Variables::   Environment variables that all versions of Emacs use.
-* Misc Variables::      Certain system-specific variables.
-* MS-Windows Registry:: An alternative to the environment on MS-Windows.
-
-X Options and Resources
-
-* Resources::           Using X resources with Emacs (in general).
-* Table of Resources::  Table of specific X resources that affect Emacs.
-* Face Resources::      X resources for customizing faces.
-* Lucid Resources::     X resources for Lucid menus.
-* LessTif Resources::   X resources for LessTif and Motif menus.
-* GTK resources::       Resources for GTK widgets.
-
-GTK resources
-
-* GTK widget names::      How widgets in GTK are named in general.
-* GTK Names in Emacs::    GTK widget names in Emacs.
-* GTK styles::            What can be customized in a GTK widget.
-
-Emacs and Mac OS / GNUstep
-
-* Mac / GNUstep Basics::        Basic Emacs usage under GNUstep or Mac OS.
-* Mac / GNUstep Customization:: Customizations under GNUstep or Mac OS.
-* Mac / GNUstep Events::        How window system events are handled.
-* GNUstep Support::             Details on status of GNUstep support.
-
-Emacs and Microsoft Windows/MS-DOS
-
-* Windows Startup::     How to start Emacs on Windows.
-* Text and Binary::     Text files use CRLF to terminate lines.
-* Windows Files::       File-name conventions on Windows.
-* ls in Lisp::          Emulation of @code{ls} for Dired.
-* Windows HOME::        Where Emacs looks for your @file{.emacs}.
-* Windows Keyboard::    Windows-specific keyboard features.
-* Windows Mouse::       Windows-specific mouse features.
-* Windows Processes::   Running subprocesses on Windows.
-* Windows Printing::    How to specify the printer on MS-Windows.
-* Windows Fonts::       Specifying fonts on MS-Windows.
-* Windows Misc::        Miscellaneous Windows features.
-* MS-DOS::              Using Emacs on MS-DOS (otherwise known as @dfn{MS-DOG}).
-
-Emacs and MS-DOS
-
-* MS-DOS Keyboard::     Keyboard conventions on MS-DOS.
-* MS-DOS Mouse::        Mouse conventions on MS-DOS.
-* MS-DOS Display::      Fonts, frames and display size on MS-DOS.
-* MS-DOS File Names::   File name conventions on MS-DOS.
-* MS-DOS Printing::     Printing specifics on MS-DOS.
-* MS-DOS and MULE::     Support for internationalization on MS-DOS.
-* MS-DOS Processes::    Running subprocesses on MS-DOS.
+* Acknowledgments::
 
 @end detailmenu
 @end menu
@@ -1341,7 +284,11 @@
 occasionally, or subscribing to periodic updates.
 
 @iftex
-@node Acknowledgments, Intro, Distrib, Top
+@menu
+* Acknowledgments::
+@end menu
+
+@node Acknowledgments,  , Distrib, Distrib
 @unnumberedsec Acknowledgments
 
 Contributors to GNU Emacs include Jari Aalto, Per Abrahamsen, Tomas
@@ -1428,7 +375,7 @@
 Neal Ziring, Teodor Zlatanov, and Detlev Zundel.
 @end iftex
 
-@node Intro, Glossary, Distrib, Top
+@node Intro, Copying, Distrib, Top
 @unnumbered Introduction
 
   You are reading about GNU Emacs, the GNU incarnation of the
@@ -1509,11 +456,11 @@
 @include custom.texi
 @include trouble.texi
 
-@node Copying, GNU Free Documentation License, Service, Top
+@node Copying, GNU Free Documentation License, Intro, Top
 @appendix GNU GENERAL PUBLIC LICENSE
 @include gpl.texi
 
-@node GNU Free Documentation License, Emacs Invocation, Copying, Top
+@node GNU Free Documentation License, Key Index, Copying, Top
 @appendix GNU Free Documentation License
 @include doclicense.texi
 
@@ -1540,13 +487,13 @@
 @c It is not after Concept Index for similar reasons.
 
 @iftex
-@node Key Index, Command Index, Glossary, Top
+@node Key Index, Key Index, GNU Free Documentation License, Top
 @unnumbered Key (Character) Index
 @printindex ky
 @end iftex
 
 @ifnottex
-@node Key Index, Option Index, Glossary, Top
+@node Key Index, Option Index, Key Index, Top
 @unnumbered Key (Character) Index
 @printindex ky
 
@@ -1554,13 +501,13 @@
 @unnumbered Command-Line Options Index
 @printindex op
 
-@node Command Index, Variable Index, Option Index, Top
+@node Command Index, Command Index, Option Index, Top
 @unnumbered Command and Function Index
 @printindex fn
 @end ifnottex
 
 @iftex
-@node Command Index, Variable Index, Key Index, Top
+@node Command Index, Variable Index, Command Index, Top
 @unnumbered Command and Function Index
 @printindex fn
 @end iftex
@@ -1569,7 +516,7 @@
 @unnumbered Variable Index
 @printindex vr
 
-@node Concept Index, Acknowledgments, Variable Index, Top
+@node Concept Index,  , Variable Index, Top
 @unnumbered Concept Index
 @printindex cp
 

[-- Attachment #3: makeinfo-output.txt --]
[-- Type: text/plain, Size: 8234 bytes --]

~/scratch/emacs.texi:515: Prev field of node `Variable Index' not pointed to.
~/scratch/emacs.texi:504: This node (Command Index) has the bad Next.
~/scratch/emacs.texi:504: Next field of node `Command Index' not pointed to (perhaps incorrect sectioning?).
~/scratch/emacs.texi:504: This node (Command Index) has the bad Prev.
~/scratch/emacs.texi:496: Prev field of node `Key Index' not pointed to.
~/scratch/emacs.texi:496: This node (Key Index) has the bad Next.
~/scratch/ack.texi:6: Prev field of node `Acknowledgments' not pointed to.
~/scratch/emacs.texi:519: This node (Concept Index) has the bad Next.
~/scratch/glossary.texi:5: Next field of node `Glossary' not pointed to (perhaps incorrect sectioning?).
~/scratch/emacs.texi:496: This node (Key Index) has the bad Prev.
~/scratch/glossary.texi:5: Prev field of node `Glossary' not pointed to.
~/scratch/emacs.texi:378: This node (Intro) has the bad Next.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Glossary' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Manifesto' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Microsoft Windows' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Mac OS / GNUstep' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Antinews' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `X Resources' despite being its Up target.
~/scratch/cmdargs.texi:5: Prev field of node `Emacs Invocation' not pointed to.
~/scratch/emacs.texi:463: This node (GNU Free Documentation License) has the bad Next.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Emacs Invocation' despite being its Up target.
~/scratch/emacs.texi:463: Next field of node `GNU Free Documentation License' not pointed to (perhaps incorrect sectioning?).
~/scratch/emacs.texi:496: This node (Key Index) has the bad Prev.
~/scratch/trouble.texi:1106: Next field of node `Service' not pointed to (perhaps incorrect sectioning?).
~/scratch/emacs.texi:459: This node (Copying) has the bad Prev.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Service' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Contributing' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Bugs' despite being its Up target.
~/scratch/trouble.texi:136: Prev field of node `Lossage' not pointed to.
~/scratch/trouble.texi:18: This node (Quitting) has the bad Next.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Lossage' despite being its Up target.
~/scratch/trouble.texi:18: `Quitting' has no Up field (perhaps incorrect sectioning?).
~/scratch/custom.texi:5: `Customization' has no Up field (perhaps incorrect sectioning?).
~/scratch/package.texi:5: `Packages' has no Up field (perhaps incorrect sectioning?).
~/scratch/misc.texi:2521: Next field of node `Amusements' not pointed to (perhaps incorrect sectioning?).
~/scratch/package.texi:5: This node (Packages) has the bad Prev.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Amusements' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Hyperlinking' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Emulation' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Recursive Edit' despite being its Up target.
~/scratch/misc.texi:2129: Prev field of node `Saving Emacs Sessions' not pointed to.
~/scratch/misc.texi:2073: This node (Editing Binary Files) has the bad Next.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Saving Emacs Sessions' despite being its Up target.
~/scratch/misc.texi:2073: `Editing Binary Files' has no Up field (perhaps incorrect sectioning?).
~/scratch/picture-xtra.texi:7: `Picture Mode' has no Up field (perhaps incorrect sectioning?).
~/scratch/misc.texi:1932: `Sorting' has no Up field (perhaps incorrect sectioning?).
~/scratch/misc.texi:1651: Next field of node `Printing' not pointed to (perhaps incorrect sectioning?).
~/scratch/misc.texi:1932: This node (Sorting) has the bad Prev.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Printing' despite being its Up target.
~/scratch/misc.texi:1369: Prev field of node `Emacs Server' not pointed to.
~/scratch/misc.texi:414: This node (Shell) has the bad Next.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Emacs Server' despite being its Up target.
~/scratch/misc.texi:414: `Shell' has no Up field (perhaps incorrect sectioning?).
~/scratch/misc.texi:234: `Document View' has no Up field (perhaps incorrect sectioning?).
~/scratch/misc.texi:23: `Gnus' has no Up field (perhaps incorrect sectioning?).
~/scratch/rmail.texi:5: `Rmail' has no Up field (perhaps incorrect sectioning?).
~/scratch/sending.texi:5: `Sending Mail' has no Up field (perhaps incorrect sectioning?).
~/scratch/calendar.texi:5: `Calendar/Diary' has no Up field (perhaps incorrect sectioning?).
~/scratch/dired.texi:5: `Dired' has no Up field (perhaps incorrect sectioning?).
~/scratch/abbrevs.texi:5: `Abbrevs' has no Up field (perhaps incorrect sectioning?).
~/scratch/maintaining.texi:5: Next field of node `Maintaining' not pointed to (perhaps incorrect sectioning?).
~/scratch/abbrevs.texi:5: This node (Abbrevs) has the bad Prev.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Maintaining' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Building' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Programs' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Text' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Indentation' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Modes' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `International' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Frames' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Windows' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Buffers' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Files' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Keyboard Macros' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Fixit' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Search' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Display' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Registers' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Killing' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Mark' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Help' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `M-x' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Minibuffer' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Basic' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Exiting' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Entering Emacs' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Commands' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Keys' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `User Input' despite being its Up target.
~/scratch/emacs.texi:97: Node `Top' lacks menu item for `Screen' despite being its Up target.
~/scratch/glossary.texi:5: warning: unreferenced node `Glossary'.
makeinfo: Removing output file `~/scratch/emacs' due to errors; use --force to preserve.

Re: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Wed, 7 Dec 2011 08:08:00 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> Cc: emacs-devel@gnu.org
> 
> On Wed Dec 7 2011 Eli Zaretskii wrote:
> > It would help if you'd show the error messages from the "unhappy"
> > makeinfo.  
> 
> Thanks for your help. I attached the diffs between the original
> emacs.texi and what texinfo-master-menu made out of it
> (diff-emacs.texi.txt). Also, I attached a file makinfo-output.txt
> with the makeinfo output for the modified file emacs.texi

Here's what I see there:

 . texinfo-master-menu indeed does not support multiple-file manuals,
   so it removed all the menu items whose nodes are in files other
   than emacs.texi itself

 . texinfo-master-menu doesn't grok @iftex and @ifnottext conditionals
   (and probably the other @if... conditionals as well), so it
   produced bad Next and Prev pointers, because, e.g., this:

    @ifnottex
    ...
    @node Command Index, Variable Index, Option Index, Top
    @unnumbered Command and Function Index
    @printindex fn
    @end ifnottex

    @iftex
    @node Command Index, Variable Index, Key Index, Top
    @unnumbered Command and Function Index
    @printindex fn
    @end iftex

   looks to it as if the "Command Index" node follows the "Command
   Index" node, and therefore it generates a bogus @node line, where
   the Next pointer for "Command Index" is "Command Index" itself:

    -@node Command Index, Variable Index, Option Index, Top
    +@node Command Index, Command Index, Option Index, Top

> > As things are, I need to guess, and my guess is that
> > texinfo-master-menu does not support multi-file manuals. It only
> > works on a single buffer. At least I don't see in its code any
> > hints that it does have the ability to gather all the multiple
> > files which constitute the ELisp manual, using the @include
> > directives or some such.
> 
> If this was the case it would help if it was documented somewhere.

I agree.  As far as Emacs is concerned, the documentation is in the
doc strings, which should be enriched with a few pointers and
explanations.  But the bulk of the documentation is in the Texinfo
manual, and even if the version on CVS improves this significantly (I
wouldn't hold my breath ;-), it's anybody's guess when it will hit the
FTP site near you, since Texinfo currently undergoes a significant
surgery which I have no idea when will end and culminate in a release.

> > My advice is to use texinfo-update-node and texinfo-make-menu on
> > individual nodes or groups of nodes as you go; that's what I do.
> > Unless your manual is on a single large file, in which case I expect
> > texinfo-master-menu to just work.
> 
> While my info manual is still very short, it contains already three
> files as I am including the files gpl.texi and doclicense.texi. It
> would be unfortunate if the inclusion of these files made it already
> impossible to use texinfo-master-menu.

For manuals spread across several files, you need the following
procedure:

 . In each individual file, run texinfo-update-node and
   texinfo-make-menu as necessary (i.e., only in those nodes which you
   modified or created anew)

 . After doing the above for all the constituent files, including the
   "outer" file (the main one, which includes the other ones), invoke
   "C-u M-x texinfo-multiple-files-update RET", to update the master
   menu in the "outer" file.  (You will see in emacs.texi some
   comments that are evidence of this latter command being used on the
   Emacs manuals.)  Please read carefully the doc string of
   texinfo-multiple-files-update and its documentation in the Texinfo
   manual, before you invoke it, to make sure you understand what it
   will do.

Let me know if the above 2-step procedure does what you want.

Re: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Thu Dec 8 2011 Eli Zaretskii wrote:
> For manuals spread across several files, you need the following
> procedure:
> 
>  . In each individual file, run texinfo-update-node and
>    texinfo-make-menu as necessary (i.e., only in those nodes which you
>    modified or created anew)
> 
>  . After doing the above for all the constituent files, including the
>    "outer" file (the main one, which includes the other ones), invoke
>    "C-u M-x texinfo-multiple-files-update RET", to update the master
>    menu in the "outer" file.  (You will see in emacs.texi some
>    comments that are evidence of this latter command being used on the
>    Emacs manuals.)  Please read carefully the doc string of
>    texinfo-multiple-files-update and its documentation in the Texinfo
>    manual, before you invoke it, to make sure you understand what it
>    will do.
> 
> Let me know if the above 2-step procedure does what you want.

Thanks a lot for the detailed recipe. Up to now, the texinfo manual
I want to write is really not much more than gpl.texi and
doclicense.texi.  I started this thread because it was not quite
clear to me how things are supposed to work from a technical
perspective.  Anyway, I need the content, too, for which I'd love
yet more if there was a single emacs command taking care of it...

So from that perspective I will need a little while before I
can report in more detail about my success or failure with this
2-step procedure.

Thanks again,

Roland

Re: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Wed, 7 Dec 2011 08:08:00 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> Cc: emacs-devel@gnu.org
> 
> > As things are, I need to guess, and my guess is that
> > texinfo-master-menu does not support multi-file manuals. It only
> > works on a single buffer. At least I don't see in its code any
> > hints that it does have the ability to gather all the multiple
> > files which constitute the ELisp manual, using the @include
> > directives or some such.
> 
> If this was the case it would help if it was documented somewhere.

I added this to the doc strings of the relevant commands.

> While my info manual is still very short, it contains already three
> files as I am including the files gpl.texi and doclicense.texi. It
> would be unfortunate if the inclusion of these files made it already
> impossible to use texinfo-master-menu.

As written elsewhere, you should use texinfo-multiple-files-update.

Re: texinfo-master-menu and emacs.texi

[Glenn Morris]

Eli Zaretskii wrote:

> Unless your manual is on a single large file, in which case I expect
> texinfo-master-menu to just work.

There's an old unanswered bug report about it not working:
http://debbugs.gnu.org/cgi/bugreport.cgi?bug=2975

Re: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Wed Dec 7 2011 Glenn Morris wrote:
> > Unless your manual is on a single large file, in which case I expect
> > texinfo-master-menu to just work.
> 
> There's an old unanswered bug report about it not working:
> http://debbugs.gnu.org/cgi/bugreport.cgi?bug=2975

Thanks...Now I am yet more confused. I thought I look into
emacs.texi because I assumed that this info manual has been updated
continuously in recent years and this updating has been done with
the editor of my choice which is emacs. So what have people done who
contributed to the emacs info manual to work around these
difficulties? Which parts of emacs' texinfo support do what they are
supposed to do and which parts seem to be malfunctioning?

Roland

PS: I would find it rather ironical if emacs' texinfo support gave
me a hard time if I want to include files gpl.texi and
doclicense.texi in an info manual.

bug#2975: texinfo-master-menu and emacs.texi

[Stefan Monnier]

> Thanks...Now I am yet more confused. I thought I look into
> emacs.texi because I assumed that this info manual has been updated
> continuously in recent years and this updating has been done with
> the editor of my choice which is emacs. So what have people done who
> contributed to the emacs info manual to work around these
> difficulties? Which parts of emacs' texinfo support do what they are
> supposed to do and which parts seem to be malfunctioning?

I'm pretty sure texinfo-master-menu is not used for that, indeed.
I think "update all menus" is the more common helper command.

IIRC it also suffered from problems where it adds data to "Node"s which
should better not be added at all, so makeinfo can auto-fill it for you
(and makeinfo actually complains about what texinfo-master-menu puts
there).

Maybe the better course here is to deprecate it, seeing how noone seems
interested in fixing it (if it can be fixed).


        Stefan

bug#2975: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Wed Dec 7 2011 Stefan Monnier wrote:
> I'm pretty sure texinfo-master-menu is not used for that, indeed.
> I think "update all menus" is the more common helper command.
> 
> IIRC it also suffered from problems where it adds data to "Node"s which
> should better not be added at all, so makeinfo can auto-fill it for you
> (and makeinfo actually complains about what texinfo-master-menu puts
> there).

I am not sure I understand what you say about nodes. I started this
thread because

> The texinfo manual says about "Updating Nodes and Menus"
> 
>   If you do not use the updating commands, you need to write menus
>   and node pointers by hand, which is a tedious task.

Is there any emacs command that can help reliably for updating the nodes?
(Nodes appear to get screwed up by texinfo-master-menu.)

Of course, I believe that makeinfo can add the info about the node
pointers. But what about output formats not supported by makeinfo?
I believe that something like TeX needs them.

> Maybe the better course here is to deprecate it, seeing how noone seems
> interested in fixing it (if it can be fixed).

This would certainly help at least somewhat to clarify the
situation.

Roland

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Wed, 7 Dec 2011 15:19:59 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> Cc: 2975@debbugs.gnu.org
> 
> On Wed Dec 7 2011 Stefan Monnier wrote:
> > I'm pretty sure texinfo-master-menu is not used for that, indeed.
> > I think "update all menus" is the more common helper command.
> > 
> > IIRC it also suffered from problems where it adds data to "Node"s which
> > should better not be added at all, so makeinfo can auto-fill it for you
> > (and makeinfo actually complains about what texinfo-master-menu puts
> > there).
> 
> I am not sure I understand what you say about nodes.

What Stefan says is that the form of @node produced by
texinfo-master-menu (when it is invoked on a region and/or with a
prefix argument) includes the Next, Prev, and Up pointers, even if the
original file didn't have those pointers.  Worse, due to incomplete
support of the more advanced Texinfo features, the produced pointers
can cause makeinfo barf.  IOW, the command could potentially take a
perfectly valid Texinfo file and produce an invalid one.

The node pointers thingy is particularly baaad because makeinfo
doesn't actually need these pointers, if your Texinfo files are
structured using a few simple rules, documented in the Texinfo manual,
see "texinfo(makeinfo Pointer Creation)".

If you keep your Texinfo structured according to these rules, there's
no need for Next, Prev, and Up pointers on the @node lines; makeinfo
will compute them automatically.

By forcibly inserting these pointers, texinfo-master-menu prevents you
from using this very convenient feature: you are forced to maintain
these pointers whenever you insert or delete nodes.

> I started this thread because
> 
> > The texinfo manual says about "Updating Nodes and Menus"
> > 
> >   If you do not use the updating commands, you need to write menus
> >   and node pointers by hand, which is a tedious task.
> 
> Is there any emacs command that can help reliably for updating the nodes?
> (Nodes appear to get screwed up by texinfo-master-menu.)

Well, see above: you don't need to be bothered by that, if you adhere
to the rules explained in the Texinfo manual.

> Of course, I believe that makeinfo can add the info about the node
> pointers. But what about output formats not supported by makeinfo?
> I believe that something like TeX needs them.

TeX doesn't need them.  These pointers are there to allow traversing
the on-line manual, and are not needed for non on-line versions.

> > Maybe the better course here is to deprecate it, seeing how noone seems
> > interested in fixing it (if it can be fixed).

Define "fixed".  Which of the current misfeatures are urgent to fix?

> This would certainly help at least somewhat to clarify the
> situation.

See my other mail (which I didn't write yet ;-) about "the situation".

bug#2975: texinfo-master-menu and emacs.texi

[Štěpán Němec]

On Thu, 08 Dec 2011 07:17:40 +0100
Eli Zaretskii wrote:

>> > Maybe the better course here is to deprecate it, seeing how noone seems
>> > interested in fixing it (if it can be fixed).
>
> Define "fixed".  Which of the current misfeatures are urgent to fix?

I'd say the fact that OT1H `texinfo-master-menu' is recommended as "the
primary command" in the Texinfo manual (info "(texinfo)Updating Commands"),
and OTOH it (sometimes?) breaks things, is a rather urgent-to-be-fixed
misfeature. I've had this problem in the past, too, and had no idea
what's going on until this came up now.

I think it's very important that there is a clear recipe for maintaining
Texinfo documentation which people not interested in the details or
implementation of Texinfo (== the vast majority of Texinfo writers) can
easily find and go by.

-- 
Štěpán

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> From: Štěpán Němec <stepnem@gmail.com>
> Cc: "Roland Winkler" <winkler@gnu.org>,  2975@debbugs.gnu.org
> Date: Thu, 08 Dec 2011 11:38:01 +0100
> 
> On Thu, 08 Dec 2011 07:17:40 +0100
> Eli Zaretskii wrote:
> 
> >> > Maybe the better course here is to deprecate it, seeing how noone seems
> >> > interested in fixing it (if it can be fixed).
> >
> > Define "fixed".  Which of the current misfeatures are urgent to fix?
> 
> I'd say the fact that OT1H `texinfo-master-menu' is recommended as "the
> primary command" in the Texinfo manual (info "(texinfo)Updating Commands"),
> and OTOH it (sometimes?) breaks things, is a rather urgent-to-be-fixed
> misfeature.

The simplest fix would be to remove the updating of the @node lines.
Would anyone object?  Karl?

> I think it's very important that there is a clear recipe for maintaining
> Texinfo documentation which people not interested in the details or
> implementation of Texinfo (== the vast majority of Texinfo writers) can
> easily find and go by.

That is a separate and non-trivial project.  Texinfo Mode has a lot of
commands, some of which cater to specific workflows and organizations
of manuals.  Making a coherent set of instructions for people who are
"not interested in the details" is not an easy task.  It certainly
doesn't affect only Emacs.

However, since this discussion _is_ in the context of Emacs, let me
say this: FWIW, most changes I do in the Emacs docs do not justify
using any of the commands discussed in this bug report and in the
parallel thread on emacs-devel.  I just make the changes by hand.  I
believe others do that as well.  There are rare situations when I use
the commands discussed here, typically close to a release when there's
a need to make sure every menu is up to date.  E.g., I didn't even
remember the existence of texinfo-multiple-files-update until I bumped
into a comment in emacs.texi, although I myself added that comment
several years ago.

I guess I'm saying that the importance of these commands in the
context of maintaining Emacs documentation is somewhat exaggerated in
this thread, to say the least ;-)

bug#2975: texinfo-master-menu and emacs.texi

[Stefan Monnier]

Karl writes:
> Perhaps the description of texinfo-mode would be better off in the Emacs
> manual, instead of the Texinfo manual.  (Since it is not maintained as
> part of Texinfo.)  I'd be fine with that.  Whatever you want to do.

Sounds like a good idea, yes.

Eli writes:
> The simplest fix would be to remove the updating of the @node lines.
> Would anyone object?  Karl?

That would be great.

Eli writes:
> I guess I'm saying that the importance of these commands in the
> context of maintaining Emacs documentation is somewhat exaggerated in
> this thread, to say the least ;-)

IIUC the OP is not directly interested in maintaining Emacs
documentation but rather is trying to write a manual for another project
(BBDB, which happens to be an Emacs package).

Eli writes:
> Here's what I see there:
>  . texinfo-master-menu indeed does not support multiple-file manuals,
>    so it removed all the menu items whose nodes are in files other
>    than emacs.texi itself

A good fix here would be for texinfo-master-menu to detect the problem
and signal a warning/error.

>  . texinfo-master-menu doesn't grok @iftex and @ifnottext conditionals
>    (and probably the other @if... conditionals as well), so it
>    produced bad Next and Prev pointers, because, e.g., this:

If leaving Node pointers alone fixes this problem, then there's nothing
else to do, but otherwise texinfo-master-menu should try and detect
these problematic cases and signal an error/warning.


        Stefan

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> From: Stefan Monnier <monnier@IRO.UMontreal.CA>
> Cc: Štěpán Němec <stepnem@gmail.com>,
>         2975@debbugs.gnu.org, winkler@gnu.org,
>         Karl Berry
>  <karl@freefriends.org>
> Date: Thu, 08 Dec 2011 09:46:49 -0500
> 
> Eli writes:
> > The simplest fix would be to remove the updating of the @node lines.
> > Would anyone object?  Karl?
> 
> That would be great.

I made it extremely optional instead: only "C-u N" where N is a number
would cause @node lines to be updated with next/prev/up pointers.

> Eli writes:
> > I guess I'm saying that the importance of these commands in the
> > context of maintaining Emacs documentation is somewhat exaggerated in
> > this thread, to say the least ;-)
> 
> IIUC the OP is not directly interested in maintaining Emacs
> documentation but rather is trying to write a manual for another project
> (BBDB, which happens to be an Emacs package).

He was asking about the effects of invoking these commands on
emacs.texi.

> Eli writes:
> > Here's what I see there:
> >  . texinfo-master-menu indeed does not support multiple-file manuals,
> >    so it removed all the menu items whose nodes are in files other
> >    than emacs.texi itself
> 
> A good fix here would be for texinfo-master-menu to detect the problem
> and signal a warning/error.
> 
> >  . texinfo-master-menu doesn't grok @iftex and @ifnottext conditionals
> >    (and probably the other @if... conditionals as well), so it
> >    produced bad Next and Prev pointers, because, e.g., this:
> 
> If leaving Node pointers alone fixes this problem, then there's nothing
> else to do, but otherwise texinfo-master-menu should try and detect
> these problematic cases and signal an error/warning.

The detection and error signaling are left as an exercise for the
interested readers ;-)

bug#2975: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Thu Dec 8 2011 Eli Zaretskii wrote:
> The simplest fix would be to remove the updating of the @node lines.
> Would anyone object?  Karl?

A TeXnical question: what about using TeX to generate the output? 
To the best of my knowledge makinfo doesn't care about @node lines
being up to date or not, it can fix them itself. Does the same hold
for TeX?

Roland

bug#2975: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Thu Dec 8 2011 Roland Winkler wrote:
> On Thu Dec 8 2011 Eli Zaretskii wrote:
> > The simplest fix would be to remove the updating of the @node lines.
> > Would anyone object?  Karl?
> 
> A TeXnical question: what about using TeX to generate the output? 
> To the best of my knowledge makinfo doesn't care about @node lines
> being up to date or not, it can fix them itself. Does the same hold
> for TeX?

I am sorry, I overlooked you clarified this point in a previous
post.

Roland

bug#2975: texinfo-master-menu and emacs.texi

[Štěpán Němec]

On Thu, 08 Dec 2011 19:52:17 +0100
Roland Winkler wrote:

> On Thu Dec 8 2011 Eli Zaretskii wrote:
>> The simplest fix would be to remove the updating of the @node lines.
>> Would anyone object?  Karl?
>
> A TeXnical question: what about using TeX to generate the output? 
> To the best of my knowledge makinfo doesn't care about @node lines
> being up to date or not, it can fix them itself. Does the same hold
> for TeX?

Unless I'm missing something, you already got an answer to this question
in Eli's first reply in this thread:

---
[Roland]
> Of course, I believe that makeinfo can add the info about the node
> pointers. But what about output formats not supported by makeinfo?
> I believe that something like TeX needs them.

[Eli]
TeX doesn't need them.  These pointers are there to allow traversing
the on-line manual, and are not needed for non on-line versions.
---

(Personally I found Eli's explanation confusing -- what does "on-line"
mean here? If it means HTML, makeinfo does support HTML output -- does
it mean it doesn't cope with missing node pointers in the HTML case? If
it means the standard Info manuals, then that's the principal format
supported, isn't it...)

-- 
Štěpán

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> From: Štěpán Němec <stepnem@gmail.com>
> Cc: Eli Zaretskii <eliz@gnu.org>,  2975@debbugs.gnu.org,  Karl Berry <karl@freefriends.org>
> Date: Thu, 08 Dec 2011 20:06:45 +0100
> 
> (Personally I found Eli's explanation confusing -- what does "on-line"
> mean here? If it means HTML, makeinfo does support HTML output -- does
> it mean it doesn't cope with missing node pointers in the HTML case?

"On-line" means all on-line formats, including HTML.

What do you mean by "it doesn't cope" -- who or what is "it" here?

makeinfo does not need these pointers in the Texinfo sources to
produce them in any of its outputs that are meant for on-line
browsing.  That includes HTML (and Info, of course).

bug#2975: texinfo-master-menu and emacs.texi

[Štěpán Němec]

On Thu, Dec 08, 2011 at 09:37:29PM +0200, Eli Zaretskii wrote:
> > From: Štěpán Němec <stepnem@gmail.com>
> > Cc: Eli Zaretskii <eliz@gnu.org>,  2975@debbugs.gnu.org,  Karl Berry
> > <karl@freefriends.org>
> > Date: Thu, 08 Dec 2011 20:06:45 +0100
> >
> > (Personally I found Eli's explanation confusing -- what does
> > "on-line"
> > mean here? If it means HTML, makeinfo does support HTML output --
> > does
> > it mean it doesn't cope with missing node pointers in the HTML case?
>
> "On-line" means all on-line formats, including HTML.
>
> What do you mean by "it doesn't cope" -- who or what is "it" here?

makeinfo

> makeinfo does not need these pointers in the Texinfo sources to
> produce them in any of its outputs that are meant for on-line
> browsing.  That includes HTML (and Info, of course).

Thank you for the clarification. Wouldn't it be even clearer (and
simpler) to say that makeinfo just never needs those pointers? You
wrote:

  TeX doesn't need them.  These pointers are there to allow traversing
  the on-line manual, and are not needed for non on-line versions.

So, given that makeinfo can add the info itself when needed, is there
really ever any need for listing the node pointers explicitly at all?

--
Štěpán

bug#2975: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Thu Dec 8 2011 Št pán N mec wrote:
> So, given that makeinfo can add the info itself when needed, is there
> really ever any need for listing the node pointers explicitly at all?

If Karl or whoever could answer this question with a clear "no, these
node pointers are never needed" (say, for recent versions of makeinfo
and other tools for formatting info pages) this could make things
much easier!

Roland

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Thu, 8 Dec 2011 14:54:55 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> Cc: Eli Zaretskii <eliz@gnu.org>, 2975@debbugs.gnu.org, karl@freefriends.org
> 
> On Thu Dec 8 2011 Št pán N mec wrote:
> > So, given that makeinfo can add the info itself when needed, is there
> > really ever any need for listing the node pointers explicitly at all?
> 
> If Karl or whoever could answer this question with a clear "no, these
> node pointers are never needed" (say, for recent versions of makeinfo
> and other tools for formatting info pages) this could make things
> much easier!

I tried to explain that already, in my original mail: they are not
needed if you structure your Texinfo source according to the rules
described in "(texinfo)makeinfo Pointer Creation".

Most manuals should have no problems being structured like that (the
Emacs User Manual and Emacs Lisp Manual are actually structured
according to those rules), but some specialized uses of Texinfo cannot
be limited to tree-like structure, or don't want to use sectioning
commands (@chapter, @section, etc.) or menus, or want to order the
nodes in some special way that defeats the automatic generation of
node pointers.  For these, you must explicitly have the Next, Prev, Up
pointers in Texinfo.

bug#2975: texinfo-master-menu and emacs.texi

[Roland Winkler]

On Fri Dec 9 2011 Eli Zaretskii wrote:
> I tried to explain that already, in my original mail: they are not
> needed if you structure your Texinfo source according to the rules
> described in "(texinfo)makeinfo Pointer Creation".
> 
> Most manuals should have no problems being structured like that (the
> Emacs User Manual and Emacs Lisp Manual are actually structured
> according to those rules), but some specialized uses of Texinfo cannot
> be limited to tree-like structure, or don't want to use sectioning
> commands (@chapter, @section, etc.) or menus, or want to order the
> nodes in some special way that defeats the automatic generation of
> node pointers.  For these, you must explicitly have the Next, Prev, Up
> pointers in Texinfo.

OK, thanks a lot. For me, this is an important clarification.

Roland

bug#2975: texinfo-master-menu and emacs.texi

[Karl Berry]

    > So, given that makeinfo can add the info itself when needed, is there
    > really ever any need for listing the node pointers explicitly at all?

    If Karl or whoever could answer this question with a clear "no, these
    node pointers are never needed"

I believe Eli answered this, but to reiterate, it is only (very)
exceptional manuals which might need node pointers.

So if you're asking if texinfo-mode needs to keep supporting them, I
would say, definitely not.  In fact, I think it would be a good thing if
it didn't.  I have seen many authors have unnecessary problems due to
texinfo-mode inserting the node pointers.

k

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Fri, 9 Dec 2011 16:17:41 -0800
> From: karl@freefriends.org (Karl Berry)
> Cc: stepnem@gmail.com, eliz@gnu.org, 2975@debbugs.gnu.org
> 
>     > So, given that makeinfo can add the info itself when needed, is there
>     > really ever any need for listing the node pointers explicitly at all?
> 
>     If Karl or whoever could answer this question with a clear "no, these
>     node pointers are never needed"
> 
> I believe Eli answered this, but to reiterate, it is only (very)
> exceptional manuals which might need node pointers.
> 
> So if you're asking if texinfo-mode needs to keep supporting them, I
> would say, definitely not.  In fact, I think it would be a good thing if
> it didn't.  I have seen many authors have unnecessary problems due to
> texinfo-mode inserting the node pointers.

I updated the commentary and the doc strings of the relevant functions
in texnfo-upd.el to the effect that texinfo-update-node and the
commands that call it should only be used if one knows what they are
doing.  I also made texinfo-master-menu call texinfo-update-node only
if the prefix arg is numeric, because invoking texinfo-master-menu
with just C-u is still useful and much less problematic.

I decided not to remove the code that updates the @node lines
entirely, since texinfo-update-node could still be useful to experts
in very specialized use cases.

I also added to the doc strings of relevant commands a note about
non-support of multi-file Texinfo manuals, and a reference to
texinfo-multiple-files-update, which does.

I hope this makes the situation quite a bit better.

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Thu, 8 Dec 2011 20:59:57 +0100
> From: "Štěpán Němec" <stepnem@gmail.com>
> Cc: Štěpán Němec <stepnem@gmail.com>,
> 	winkler@gnu.org, 2975@debbugs.gnu.org, karl@freefriends.org
> 
> > makeinfo does not need these pointers in the Texinfo sources to
> > produce them in any of its outputs that are meant for on-line
> > browsing.  That includes HTML (and Info, of course).
> 
> Thank you for the clarification. Wouldn't it be even clearer (and
> simpler) to say that makeinfo just never needs those pointers?

It would, if it were true.  But it isn't, see my other mail.

bug#2975: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> Date: Thu, 8 Dec 2011 12:52:17 -0600
> From: "Roland Winkler" <winkler@gnu.org>
> Cc: Štěpán Němec <stepnem@gmail.com>,
>         2975@debbugs.gnu.org, karl@freefriends.org (Karl Berry)
> 
> On Thu Dec 8 2011 Eli Zaretskii wrote:
> > The simplest fix would be to remove the updating of the @node lines.
> > Would anyone object?  Karl?
> 
> A TeXnical question: what about using TeX to generate the output? 
> To the best of my knowledge makinfo doesn't care about @node lines
> being up to date or not, it can fix them itself. Does the same hold
> for TeX?

TeX ignores @node.

Re: texinfo-master-menu and emacs.texi

[Roland Winkler]

I thought I want to send this email to the texinfo maintainers that
we are having some discussions on emacs-devel@gnu.org about Emacs
currently not fully matching the texinfo support that is described
in the texinfo info manual.

See also:

> There's an old unanswered bug report about it not working:
> http://debbugs.gnu.org/cgi/bugreport.cgi?bug=2975

Re: texinfo-master-menu and emacs.texi

[Karl Berry]

Perhaps the description of texinfo-mode would be better off in the Emacs
manual, instead of the Texinfo manual.  (Since it is not maintained as
part of Texinfo.)  I'd be fine with that.  Whatever you want to do.

Best,
karl

Re: texinfo-master-menu and emacs.texi

[Eli Zaretskii]

> From: Glenn Morris <rgm@gnu.org>
> Cc: "Roland Winkler" <winkler@gnu.org>,  emacs-devel@gnu.org
> Date: Wed, 07 Dec 2011 12:57:19 -0500
> 
> Eli Zaretskii wrote:
> 
> > Unless your manual is on a single large file, in which case I expect
> > texinfo-master-menu to just work.
> 
> There's an old unanswered bug report about it not working:
> http://debbugs.gnu.org/cgi/bugreport.cgi?bug=2975

That bug report is now fixed and closed.

In a nutshell, Alan Mackenzie, who reported that bug, was tripped by
insufficient and inaccurate documentation of "C-c C-u m"
(texinfo-master-menu).