bugGNU Octave - Bugs: bug #48554, doc strings are missing for...

 
 

bug #48554: doc strings are missing for Octave's .oct files

Submitter:  Mike Miller <mtmiller>
Submitted:  Mon 18 Jul 2016 05:52:25 PM UTC
   
 
Category:  Interpreter Severity:  5 - Blocker
Priority:  5 - Normal Item Group:  Regression
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
   

Mon 08 Aug 2016 01:17:00 AM UTC, comment #4: 

This works for me now.  Closing report.

Rik <rik5>
Group administrator
Tue 02 Aug 2016 07:45:24 AM UTC, comment #3: 

I also checked in this changeset so that the help text for operators and keywords is also found in the docstrings file.

http://hg.savannah.gnu.org/hgweb/octave/rev/af0dca907fae

John W. Eaton <jwe>
Group administrator
Tue 02 Aug 2016 07:18:03 AM UTC, comment #2: 

I checked in the following changeset:

  http://hg.savannah.gnu.org/hgweb/octave/rev/f6181638f6c5

John W. Eaton <jwe>
Group administrator
Mon 18 Jul 2016 09:34:03 PM UTC, comment #1: 

Oh, I see.  Ultimately, I had planned to only load the docstrings on demand rather than loading them all at startup

John W. Eaton <jwe>
Group administrator
Mon 18 Jul 2016 05:52:25 PM UTC, original submission:  

Since this change

http://hg.savannah.gnu.org/hgweb/octave/rev/112b20240c87

doc strings for .oct files are no longer accessible.

The quick fix would be to revert that change for the libinterp/dldfcn/*.cc files.

The built-in-docstrings file that is shipped with Octave contains the doc strings for both built-in functions and .oct file functions in the dldfcn directory. However, the install_built_in_docstrings function only loads the doc string if it's for a built-in.

I don't think changing the function to load doc strings for .oct files will work, because they are probably cleared when the function is unloaded, for example with "clear functions".

Since we don't have a solution at the moment for loading comment-based doc strings from compiled .oct files, I think we should just change those files back to using strings compiled in to the object code.

Mike Miller <mtmiller>
Group Member

 

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

Attach Files:
   
   
Comment:
   

No files currently attached

 

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 jwe (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
    2016-08-08 rik5 StatusReady For Test Fixed
        Open/ClosedOpen Closed
    2016-08-02 jwe StatusNone Ready For Test

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code