bugGNU Octave - Bugs: bug #48722, Unescape quotes in @qcode macro to...

 
 

bug #48722: Unescape quotes in @qcode macro to avoid a Texinfo parsing error

Submitted by:  Rafael Laboissiere <rlaboiss>
Submitted on:  Mon 08 Aug 2016 02:53:16 PM UTC  
 
Category: DocumentationSeverity: 3 - Normal
Priority: 5 - NormalItem Group: Build Failure
Status: FixedAssigned to: None
Originator Name: Open/Closed: Closed
Release: devOperating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

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

 

Thu 11 Aug 2016 10:54:59 PM UTC, comment #3:

I pushed a cset (http://hg.savannah.gnu.org/hgweb/octave/rev/1c840b2fd337) to remove escapes from within @qcode macros both for qr.cc and the deprecated luinc.m

Rik <rik5>
Project Administrator
Tue 09 Aug 2016 10:44:31 AM UTC, comment #2:

Hi Anonymous,

Thanks for your comments. Actually, the construct @qcode{\"something\"} appears only in two files:

For the first case, besides the fact the script luinc.m is deprecated, @qcode{\"vector\"} should read, in fact, @qcode{"vector"}. Otherwise, the documentation looks awkward.

For the second case (genpropdoc.m), all occurrences of the construct @qcode{\"something\"} appear inside strings in the Octave code. That is the reason the double quotes must be escaped.

However, the above does not answer your question. The bug in the docstring for qrdelete is triggered because that docstring is processed by texinfo, in the process of building the Octave manual, which is not the case for luinc. Indeed, you can try:

Rafael Laboissière

Rafael Laboissiere <rlaboiss>
Mon 08 Aug 2016 06:52:08 PM UTC, comment #1:

I had a quick look and there are many other files which use @qcode{\", some examples:

are these also problematic?

(found with
find . -name "*.m" -exec egrep -Hn --color=auto '@qcode{\\' {} \;)

Anonymous
Mon 08 Aug 2016 02:53:16 PM UTC, original submission:

Buildinfg for source fails for the current hg tip, with the following error message:

The trivial patch attached to this bug report fixes the problem.

Rafael Laboissière

Rafael Laboissiere <rlaboiss>

 

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

Attach File(s):
   
   
Comment:
   

Attached Files

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by rlaboiss (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 11 Aug 2016 10:54:59 PM UTCrik5StatusNone=>Fixed
      Open/ClosedOpen=>Closed
    Mon 08 Aug 2016 02:53:16 PM UTCrlaboissAttached File-=>Added unescape-quote-in-qrdelete-docstring.diff, #38149

    Back to the top


    Powered by Savane 3.1-cleanup1