[Octave-bug-tracker] [bug #33208] Texinfo requires no spaces in the beginning of lines

[Søren Hauberg]

URL:
  <http://savannah.gnu.org/bugs/?33208>

                 Summary: Texinfo requires no spaces in the beginning of lines
                 Project: GNU Octave
            Submitted by: hauberg
            Submitted on: Mon 02 May 2011 05:29:28 PM CEST
                Category: Interpreter
                Severity: 3 - Normal
                Priority: 5 - Normal
              Item Group: Other
                  Status: None
             Assigned to: None
         Originator Name: Søren Hauberg
        Originator Email: 
             Open/Closed: Open
         Discussion Lock: Any
                 Release: dev
        Operating System: GNU/Linux

    _______________________________________________________

Details:

Hi

While working on improving syntax highlighting for Gedit, Carnë Draug noticed
that Texinfo actually requires that all commands start at the beginning of a
line. The Octave help system does not match this requirement.

The Octave help system works by stripping the comment signs (# or %) from the
block containing the help text and passing the result to the makeinfo program.
Most Texinfo help texts look something like this:


## @deftypefn{Function File} funname
## help text goes here
## @end deftypefn


When the ##'s are removed there is still a space left in the beginning of each
line. Currently, this is working just fine as the makeinfo accepts the extra
space most of the time. However, the next version of makeinfo will either give
an error or a warning if such a space exists. Therefore, I think we should fix
the issue before it hits us.

I am, however, unsure about the solution. Should we simply change
'get_help_text' to strip all spaces in the beginning of lines? Or perhaps only
the first space? Or perhaps something smarter?

Søren




    _______________________________________________________

Reply to this item at:

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

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