[rtems commit] Add missing @item.

Joel Sherrill joel.sherrill at OARcorp.com
Tue Feb 26 14:24:23 UTC 2013

On 2/26/2013 7:04 AM, Ralf Corsepius wrote:
> On 02/26/2013 01:18 PM, Joel Sherrill wrote:
>> I appreciate you fixing these but I have a local branch I am about to push which fixes this and about a dozen other things. Save your effort until I push it.
> OK, I can stop investigating texinfo-5.0 and your doc build issues.
I just didn't want you to waste time investigating texinfo 5.0 when I had
texiany support in a local branch and multiple fixes to texinfo files. I 
pushed it now so there won't be any duplicate work.

I just pushed my branch. The summary is:

+ If texi2any (e.g. texinfo 5.0) is in PATH, use it instead of texi2html.
    This includes a handful of fairly small and tedious changes:
       - added texi2any init file
       - added some autoconf logic
       - added texi2any invocation
+ I switched us to an html file naming convention recommended by
    the texinfo maintainers for stable URLs. This means generated html
    files are based on section names rather than $(PROJECT)_nnn.html.
    This is based on a standard from around 2004 per them.   This is
    the preferred way of doing things now and the old way isn't supported
    by texi2any.
      - This required modification of the html dependency rules. I don't 
        if they are 100% correct but they work.
+ I updated two figures which were rotated 90% incorrectly in the manual.
+ I did a fair amount of rework on the master document files $(PROJECT).texi
    because we apparently got away with some incorrect texinfo with the
    older tools.
+ Many PDFs included a page with nothing but the title page. This was
    the @top node incorrectly being included in the PDF and other printable
+ Multiple minor issues I spotted while reviewing:
   - I updated the preface to add a couple of architectures.
   - I fixed the overview since it didn't list all the chapters and 
those that it
     did list were not always in the right order.
   - I fixed a few places where the lines were too long and ran into the 
   - I corrected at least one code example which was clearly out of date.
   - Copyright and modified dates touched

Since updating to texi2any is going to eventually be faced by others, I 
wrote a
blog entry this weekend:


At this point, I think it at least builds with old or new texinfo and 
the PDF output is

At this point, I don't have any more outstanding patches but I do think 
we are
due for a "group documentation review sprint". With a bit of group 
maybe we can split up documents by chapter and get a reviewer per chapter.

Now we won't duplicate work. I was just trying to safe you some work


> _______________________________________________
> rtems-devel mailing list
> rtems-devel at rtems.org
> http://www.rtems.org/mailman/listinfo/rtems-devel

Joel Sherrill, Ph.D.             Director of Research & Development
joel.sherrill at OARcorp.com        On-Line Applications Research
Ask me about RTEMS: a free RTOS  Huntsville AL 35805
Support Available                (256) 722-9985

More information about the devel mailing list