bugGNU Octave - Bugs: bug #38392, Texinfo 5.0 breaks documentation

 
 

bug #38392: Texinfo 5.0 breaks documentation

Submitted by:  Stefan Husmann <haawda>
Submitted on:  Sat 23 Feb 2013 10:23:50 PM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Incorrect Documentation
Status: FixedAssigned to: None
Originator Name: Stefan HusmannOpen/Closed: Closed
Release: devOperating System: GNU/Linux

Add a New Comment (Rich MarkupRich Markup):
   

You are not logged in

Please log in, so followups can be emailed to you.

 

(Jump to the original submission Jump to the original submission)

Wed 01 May 2013 02:51:40 AM UTC, comment #10:

OP confirmed this is now working, closing as fixed.

Mike Miller <mtmiller>
Project Member
Tue 30 Apr 2013 03:32:10 AM UTC, comment #9:

I am not getting any @deftypefn errors or warnings building the documentation, on revision 3ce0c312a40b. I have built it with both the texinfo 5.0 release and from texinfo svn trunk. All issues fixed?

Mike Miller <mtmiller>
Project Member
Sat 27 Apr 2013 10:10:37 PM UTC, comment #8:

texinfo 4.13a should not have that issue.

Stefan Husmann <haawda>
Sat 27 Apr 2013 06:45:03 PM UTC, comment #7:

Do you know which version(s) of texinfo the current Octave 3.6.4 build does work with? I'm getting the same texinfo error when trying to build Octave 3.6.4 under Homebrew on Mac OS X 10.8.3 and 10.7.5, which come with texinfo 4.8.

(I'm building it without FLTK and getting the error. When built with FLTK, the error doesn't happen. I don't know why this interaction happens.)

Andrew Janke <andrewjanke>
Mon 25 Feb 2013 04:44:51 AM UTC, comment #6:

I pushed one more changeset which should fix the last warning (http://hg.savannah.gnu.org/hgweb/octave/rev/9720ecf8d257).

The @deftypefn errors, however, will need someone to rewrite each documentation string that uses @deftypefn separated from @deftypefnx. To find the function that needs editing look at the error line in plot.texi, for example plot.texi:2810. If you search backwards in the file for @deftypefn you will find

and above that there will be a Texinfo comment line which begins with '@c' which says where the documentation string came from. In this case the line is

which says which m-file needs rewriting.

Rik <rik5>
Project Administrator
Sun 24 Feb 2013 05:57:58 PM UTC, comment #5:

Thank you. Indeed many of the issues are fixed for me with your changeset.

The remaining ones are that ones using the mentioned using @deftypefn and @deftypefnx. These are the ones causing the build to stop. There are two more warnings.

Stefan Husmann <haawda>
Sun 24 Feb 2013 03:22:17 PM UTC, comment #4:

I pushed a changeset which fixes most of the issues reported (http://hg.savannah.gnu.org/hgweb/octave/rev/8899c785cc99).

However Octave is using a syntax with @deftypefn and @deftypefnx separated by multiple lines of documentation. This has been perfectly legal syntax in the past and modifying all of those occurrences is an invasive project.

Is the problem really that the documentation won't finish building? Or is the issue that warnings are being emitted during the build? We can live with warnings being printed and just ignore them.

Rik <rik5>
Project Administrator
Sun 24 Feb 2013 03:08:55 PM UTC, comment #3:

The function help text is not included directly in the manual texinfo pages. Instead they are linked to the actual functions help text. You will see things such as

which means include the plotyy documentation here. You'll have to track down which ones are causing the problem. See on the autogenerated files to what functions they belong.

Carnë Draug <carandraug>
Project Member
Sat 23 Feb 2013 11:34:56 PM UTC, comment #2:

The fixes are far from being obvious to me. Most of the files affected are autogenerated. F.i. there is no occurrence of @deftypefnx in plot.txi.

Stefan Husmann <haawda>
Sat 23 Feb 2013 10:27:17 PM UTC, comment #1:

Can you prepare a patch? The fixes all seem obvious.

Jordi Gutiérrez Hermoso <jordigh>
Project Administrator
Sat 23 Feb 2013 10:23:50 PM UTC, original submission:

After my distro Arch Linux switched to Texinfo 5.0, the documentation cannot be built freshly.

Stefan Husmann <haawda>

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Digest:
   bug dependencies.

 

Carbon-Copy List
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by andrewjanke (Posted a comment)
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by jordigh (Posted a comment)
  • -unavailable- added by haawda (Submitted the item)
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 3 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 02 May 2013 01:36:08 AM UTCmtmillerDependencies-=>bugs #38865 is dependent
    Wed 01 May 2013 02:51:40 AM UTCmtmillerStatusNone=>Fixed
      Open/ClosedOpen=>Closed

    Back to the top


    Powered by Savane 3.1-cleanup