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

 
 

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

Submitter:  Rafael Laboissière <rlaboiss>
Submitted:  Mon 08 Aug 2016 02:53:16 PM UTC
 
Category:  Documentation 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 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>
Group 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:


$ find . -name "*.m" -exec grep -l '@qcode{\\"' {} \;
./scripts/deprecated/luinc.m
./doc/interpreter/genpropdoc.m


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:


info octave --index-search=qrdelete
info octave --index-search=luinc


Rafael Laboissière

Rafael Laboissière <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:


./scripts/deprecated/luinc.m:75:## Given the string argument @qcode{\"vector\"}, @code{luinc} returns the
./doc/interpreter/genpropdoc.m:134:        s.doc = "If __prop__ is @qcode{\"on\"}, the __objname__ is \


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:


TEXINPUTS="./build-aux:$TEXINPUTS" \
MAKEINFO='/bin/bash /path/to/octave/build-aux/missing makeinfo   -I doc/interpreter -I ./doc/interpreter' \
texi2dvi  --build-dir=doc/interpreter/octave.t2d -o doc/interpreter/octave.dvi  \
`test -f 'doc/interpreter/octave.texi' || echo '/path/to/octave/'`doc/interpreter/octave.texi
[snip]
/path/to/octave/doc/interpreter/linalg.texi:1265:
Argument of @" has an extra }.
<inserted text>
                @par
<to be read again>
                   }
@tclose ...n @rawbackslash @plainfrenchspacing #1}
                                                  @null
@codex #1->@tclose {#1}
                       @endgroup
l.1 @code{@xeatspaces {@"col@"}}
                                @empty
@scanmacro ...spaceisspace @scantokens {#1@empty }
                                                  @endgroup
...
l.1265 (if @var{orient} is @qcode{\"col\"}
                                          ),


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

Rafael Laboissière

Rafael Laboissière <rlaboiss>

 

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

Attach Files:
   
   
Comment:
   

Attached Files

 

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 rlaboiss (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 project members can vote.

     

     

     

     

    Follow 3 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2016-08-11 rik5 StatusNone Fixed
        Open/ClosedOpen Closed
    2016-08-08 rlaboiss Attached File- Added unescape-quote-in-qrdelete-docstring.diff, #38149

    Back to the top

    Powered by Savane 3.12