bugGNU Octave - Bugs: bug #39778, doc-cache is empty when building...

 
 

bug #39778: doc-cache is empty when building with texinfo 5.x

Submitter:  Mike Miller <mtmiller>
Submitted:  Tue 13 Aug 2013 05:46:03 AM UTC
   
 
Category:  Configuration and Build System Severity:  3 - Normal
Priority:  5 - Normal Item Group:  Build Failure
Status:  Fixed Assigned to:  None
Originator Name:  Open/Closed:  * Closed
Release:  * dev Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 15 Aug 2013 03:23:50 AM UTC, comment #4: 

Yes, this works with 5.1 also.

Mike Miller <mtmiller>
Group Member
Wed 14 Aug 2013 07:50:45 PM UTC, comment #3: 

Alas, 0x1e is a reserved character for Texinfo 4.13 and doc-cache is now empty for me.

According to Wikipedia the ASCII control characters in this range are:


29         1D         GS         Group Separator
30         1E         RS         Record Separator
31         1F         US         Unit Separator


We've tried "Unit Separator" and "Record Separator".  What about "Group Separator"?  I made a changeset which uses 0x1d and it works for me with version 4.13.  I'm attaching it to the bug report and you can test it out.  If it works in 5.X versions then I'll commit it.


(file #28843)

Rik <rik5>
Group administrator
Wed 14 Aug 2013 03:56:04 AM UTC, comment #2: 

Thanks, Rik. Your suggestion to try another delimiter was actually right on. I pushed the following changeset to use ASCII 30 (0x1e, record separator), which works with texinfo 5.1 now. Please test and let me know if this breaks with 4.13.

http://hg.savannah.gnu.org/hgweb/octave/rev/3f4091dddc13

No guarantee that this control character won't get filtered by texinfo at some point in the future, but it works for now.

For reference, here is where ASCII 31 (0x1f, unit separator) is being specifically used and consumed by texinfo currently (scroll to line 548):

http://svn.savannah.gnu.org/viewvc/trunk/tp/Texinfo/Convert/Plaintext.pm?annotate=5291&root=texinfo

That file also has code that specifically works with form feeds as well.

Mike Miller <mtmiller>
Group Member
Tue 13 Aug 2013 04:00:50 PM UTC, comment #1: 

I'm still at Texinfo 4.13 so you might have to debug this on your own.  It's really annoying that they seemed to have introduced so many new bugs without an increase in functionality.  See this discussion from Guile programmers who are using the same technique (with a different special character) to divide up records (http://gnu-guile.7481.n7.nabble.com/makeinfo-swallows-page-breaks-td16347.html).  The problem of removing special characters may be related to the handling of accented characters and the document encoding:


Options for Info and plain text:
    --disable-encoding
           do not output accented and special  characters  in  Info  output
           based on @documentencoding.

    --enable-encoding
           override --disable-encoding (default).


So I might try setting the document encoding to bare ASCII playing with that.  You could gin up your own test file as well.  We could use a different delimiter character, ASCII 29 and ASCII 30, would also be fine.  Although, my guess is it doesn't like any ASCII control character whatsoever.

Rik <rik5>
Group administrator
Tue 13 Aug 2013 05:46:03 AM UTC, original submission:  

I've run across yet another texinfo 5.x incompatibility. Building with makeinfo 5.1, the doc-cache file has no elements in it, just a header indicating that the cache variable is a 3x0 array.

The doc-cache file is used by the lookfor function, so with an empty cache lookfor searches always return empty.

From what I've been able to figure out, the mk_doc_cache.m script expects the unit separator character (ASCII 31) to be passed through untouched to the output of makeinfo. This appears to no longer be the case with makeinfo 5.1. This new version also doesn't appear to respect the --fill-column option, the output seems to wrap at 72 columns.

Mike Miller <mtmiller>
Group Member

 

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

Attach Files:
   
   
Comment:
   

Attached Files
file #28843:  tex_sep.cset added by rik5 (3KiB - application/octet-stream)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by rik5 (Posted a comment)
  • -email is unavailable- added by mtmiller (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

    Only group members can vote.

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2013-08-14 rik5 Attached File- Added tex_sep.cset, #28843
    2013-08-14 mtmiller StatusNone Fixed
        Open/ClosedOpen Closed

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code