[Octave-bug-tracker] [bug #35187] the "help" command displays truncated help (words missing, etc)

[Mark Messer]

Follow-up Comment #7, bug #35187 (project octave):

This issue has been a problem for me too. 

I expect the source for the help is a TexInfo file. This file is
transliterated into various formats for distribution with Octave. I think the
issue is caused by transliteration errors. Tools on some systems can handle
the errors, and others can't. 

I installed Octave 3.4.3 on 32 bit Windows Vista, with all packages. I get
this when I type help inv.

<textarea class="verbatim" readonly="readonly" rows="20" cols="80">octave:112>
help inv
`inv' is a function from the file C:OctaveOctave3.4.3_gcc4.5.2Octave3.4.3_gcc
4.5.2liboctave3.4.3octi686-pc-mingw32inv.oct



 -- Loadable Function: X = inv (A)
 -- Loadable Function: [X, RCOND] = inv (A)
     Compute the inverse of the square matrix A.  Return an estimate
     of the reciprocal condition number if requested, otherwise warn of
 ill-conditioned matrix if the reciprocal condition number is
 In general it is best to avoid calculating the inverse
 directly.  For example, it is both faster and more
 `Y = A of equations (A*x = b) with
 If called with a sparse
 matrix requiring in general X will be a full
 of asignificantly more storage.  Avoid forming the inverse
 See also: ldivide, rdivideble.



Additional help for built-in functions and operators is
available in the on-line version of the manual.  Use the command
`doc <topic>' to search the manual index.

Help and information about Octave is also available on the WWW
at http://www.octave.org and via the address@hidden
mailing list.
</textarea>

I found 4 files under C:Octave for files containing "Compute the inverse of
the square matrix A.  Return an estimate". There may be more. All these files
contain descriptions of many functions. 3 of the files look OK, and can
correctly display information about inv. The last one matches the messed up
'help inv' display to a degree. 

Two good files are under
C:OctaveOctave3.4.3_gcc4.5.2Octave3.4.3_gcc4.5.2dococtave. They are
htmloctave.htmlBasic-Matrix-Functions.html and pdfoctave.pdf. The files under
this folder can be used for a work around until the issue is fixed. (The table
of contents in the PDF file has errors. E.G. The TOC says 18.2 Basic Matrix
Functions begins on p 377. In fact, it begins on p 365.)

The other good file is
C:OctaveOctave3.4.3_gcc4.5.2Octave3.4.3_gcc4.5.2shareoctave3.4.3etcdoc-cache.
It contains text with some strings to help quickly search and parse it. 

The bad file is
C:OctaveOctave3.4.3_gcc4.5.2Octave3.4.3_gcc4.5.2shareinfooctave.info-3. It
contains text. Some awkward word wrapping in this file matches missing words
in the help display. cr/lf line endings are inconsistent in the file. The inv
discussion mentions the backslash operator. One line ends with backslash
linefeed. This line in the help display is especially messed up. 

Note that the modification dates on all 4 files are the same. The date is
before I installed Octave. 

Note the HTML file contains a comment that shows some problems exist with
transliteration. 

<!-- Texinfo @sp should work but in practice produces ugly results for HTML.
-->
<!-- A simple blank line produces the correct behavior. -->
<!-- @sp 1 -->

Note the displayed help contains three sections: top (-- 'inv' is a function
...), middle (matches contents of the bad file), and bottom (Additional help
for ...). I only see problems with the middle part. 

I tried editing the bad file. It did not change the displayed help. Perhaps
the displayed help is cached somewhere. If so, I did not find it. Perhaps the
help display is based on a file I did not find. 



    _______________________________________________________

Reply to this item at:

  <http://savannah.gnu.org/bugs/?35187>

_______________________________________________
  Message sent via/by Savannah
  http://savannah.gnu.org/