[PATCH] libgloss: add a little build system generation documentation

[Stafford Horne]

On Thu, Mar 3, 2022 at 8:54 PM Tamar Christina <Tamar.Christina@arm.com> wrote:
>
> Indeed, it's failing with 6.7 on Ubuntu 20.04.
>
> The patch didn't seem to help.
>
> It did put up an additional warning with the patch
>
> src-newlib/libgloss/doc/porting.texi:314: warning: node `Build System Internals' is next for `Board support' in sectioning but not in menu
> src-newlib/libgloss/doc/porting.texi:360: warning: node `Board support' is prev for `Build System Internals' in sectioning but not in menu
> src-newlib/libgloss/doc/porting.texi:360: warning: node `Libgloss' is up for `Build System Internals' in sectioning but not in menu
> src-newlib/libgloss/doc/porting.texi:87: node `Libgloss' lacks menu item for `Build System Internals' despite being its Up target
> make[3]: *** [Makefile:1233: src-newlib/libgloss/doc/porting.info] Error 1
>
> first one is new.
>
> Regards,
> Tamar
>
> > -----Original Message-----
> > From: Richard Earnshaw <Richard.Earnshaw@foss.arm.com>
> > Sent: Thursday, March 3, 2022 11:44 AM
> > To: Tamar Christina <Tamar.Christina@arm.com>; newlib@sourceware.org
> > Subject: Re: [PATCH] libgloss: add a little build system generation
> > documentation
> >
> >
> >
> > On 03/03/2022 04:22, Mike Frysinger wrote:
> > > On 02 Mar 2022 13:10, Tamar Christina wrote:
> > >> This commit seems to break the build:
> > >>
> > >> make[3]: Entering directory '/newlib/aarch64-none-elf/libgloss'
> > >>    MAKEINFO /src-newlib/libgloss/doc/porting.info
> > >> /src-newlib/libgloss/doc/porting.texi:360: warning: node `Board
> > >> support' is prev for `Build System Internals' in sectioning but not
> > >> in menu
> > >> /src-newlib/libgloss/doc/porting.texi:360: warning: node `Libgloss'
> > >> is up for `Build System Internals' in sectioning but not in menu
> > >> /src-newlib/libgloss/doc/porting.texi:87: node `Libgloss' lacks menu
> > >> item for `Build System Internals' despite being its Up target
> > >> make[3]: *** [Makefile:1233: /src-newlib/libgloss/doc/porting.info]
> > >> Error 1
> > >> make[3]: Leaving directory '/newlib/aarch64-none-elf/libgloss'
> > >> make[2]: *** [Makefile:1439: all-recursive] Error 1
> > >
> > > builds fine for me w/texinfo-6.8.  what version are you using ?
> >
> > I think it fails with 6.7, at least that's what I have on my machine, where that's
> > the standard version in Ubuntu-20.04.
> >
> > >
> > > current texinfo guidelines is to omit the 2nd+ args for @node.
> > > wonder if that would fix the build for you.
> > > -mike
> > >
> > > --- a/libgloss/doc/porting.texi
> > > +++ b/libgloss/doc/porting.texi
> > > @@ -311,7 +311,7 @@
> > >   and uninstalled object tree. It also makes it easier to debug the other
> > >   tools using libgloss's test suites.
> > >
> > > -@node Board support, , Building libgloss, Libgloss
> > > +@node Board support
> > >   @section Adding Support for a New Board
> > >
> > >   This section explains how to add support for a new board to libgloss.
> >

I was getting the same failure, this patch works for me.

diff --git a/libgloss/doc/porting.texi b/libgloss/doc/porting.texi
index 5325fb2ed..7473c3706 100644
--- a/libgloss/doc/porting.texi
+++ b/libgloss/doc/porting.texi
@@ -136,6 +136,8 @@ new library is called Libgloss, for Gnu Low-level
OS support.
 * Building libgloss::           How to configure and built libgloss
                                 for a target.
 * Board support::               How to add support for a new board.
+
+* Build System Internals::      How the libgloss build system works.
 @end menu

 @node Supported targets, Building libgloss, Libgloss, Libgloss