bugGNU Octave - Bugs: bug #41627, doc: Function Locking describes...

 
 

bug #41627: doc: Function Locking describes obsolete usage for the mlock function

Submitter:  Allan Jacobs <allanjacobs>
Submitted:  Mon 17 Feb 2014 06:39:49 PM UTC
   
 
Category:  Documentation Severity:  2 - Minor
Priority:  5 - Normal Item Group:  Documentation
Status:  Fixed Assigned to:  None
Originator Name:  allanjacobs Open/Closed:  * Closed
Release:  * 3.8.0 Operating System:  * Any
Fixed Release:  None Planned Release:  None
* Mandatory Fields

Add a New Comment Rich Markup
   

Thu 20 Feb 2014 05:45:58 AM UTC, comment #3: 

Fixed on the stable branch with this changeset:

http://hg.savannah.gnu.org/hgweb/octave/rev/477b5916cafe

The documentation will be fixed in the upcoming 3.8.1 release.

Mike Miller <mtmiller>
Group Member
Tue 18 Feb 2014 04:32:08 PM UTC, comment #2: 

My guess is that Matlab syntax gradually changed and Octave followed without updating the documentation.  If I look at the Matlab documentation it uses mlock/munlock in exactly the way that the docstrings for the individual functions in Octave behave.

This would be a pretty easy cleanup.

Rik <rik5>
Group administrator
Mon 17 Feb 2014 07:46:53 PM UTC, comment #1: 

Recategorizing as a documentation bug. This is most likely simply out of date documentation describing the mlock function rather than expected behavior that has been unintentionally lost. AFAICT this syntax was removed somewhere around version 3.0 of Octave.

This could be fixed for the imminent 3.8.1 if someone has time/ability/interest to update the sections of func.txi to describe mlock best practices.

Mike Miller <mtmiller>
Group Member
Mon 17 Feb 2014 06:39:49 PM UTC, original submission:  

Source code was updated on Feb 16 14:58 (Pacific Time).  The commands below come straight out of section 11.9.6 in Octave documentation.  mlock throws an error when it should not.

>> version()

ans = 4.1.0+

>> clear all
>> function count_calls ()

       persistent calls = 0;
       printf ("'count_calls' has been called %d times\n",
               ++calls);
     endfunction

>>      mlock ("count_calls");

error: Invalid call to mlock.  Correct usage is:

 -- Built-in Function: mlock ()


Additional help for built-in functions and operators is
available in the online 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 -email is unavailable-
mailing list.

Allan Jacobs <allanjacobs>

 

(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 mtmiller (Posted a comment)
  • -email is unavailable- added by allanjacobs (Submitted the item)
  • -email is unavailable- added by allanjacobs
  •  

    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 10 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2014-02-20 mtmiller StatusConfirmed Fixed
        Open/ClosedOpen Closed
    2014-02-17 mtmiller CategoryOctave Function Documentation
        Severity3 - Normal 2 - Minor
        Item GroupRegression Documentation
        StatusNone Confirmed
        Releasedev 3.8.0
        Operating SystemGNU/Linux Any
        Summarymlock function throws an error in 4.1.0+ dev build doc: Function Locking describes obsolete usage for the mlock function
    2014-02-17 allanjacobs Carbon-Copy- Added allanjacobs

    Back to the top

    Powered by Savane 3.13-d3ae.
    Corresponding source code