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

 
 

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

Submitted by:  Allan Jacobs <allanjacobs>
Submitted on:  Mon 17 Feb 2014 06:39:49 PM UTC  
 
Category: DocumentationSeverity: 2 - Minor
Priority: 5 - NormalItem Group: Documentation
Status: FixedAssigned to: None
Originator Name: allanjacobsOpen/Closed: Closed
Release: 3.8.0Operating System: Any

Add a New Comment(Rich Markup)
   

You are not logged in

Please log in, so followups can be emailed to you.

 

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>
Project Administrator
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>
Project 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>
Project Administrator
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 -unavailable-
mailing list.

Allan Jacobs <allanjacobs>

 

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

Attach File(s):
   
   
Comment:
   

No files currently attached

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -unavailable- added by rik5 (Posted a comment)
  • -unavailable- added by mtmiller (Posted a comment)
  • -unavailable- added by allanjacobs (Submitted the item)
  • -unavailable- added by allanjacobs
  •  

    Do you think this task is very important?
    If so, you can click here to add your encouragement to it.
    This task has 0 encouragements so far.

    Only project members can vote.

     

    Please enter the title of George Orwell's famous dystopian book (it's a date):

     

     

    Follow 10 latest changes.

    Date Changed By Updated Field Previous Value => Replaced By
    Thu 20 Feb 2014 05:45:58 AM UTCmtmillerStatusConfirmed=>Fixed
      Open/ClosedOpen=>Closed
    Mon 17 Feb 2014 07:46:53 PM UTCmtmillerCategoryOctave 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
    Mon 17 Feb 2014 06:39:49 PM UTCallanjacobsCarbon-Copy-=>Added allanjacobs

    Back to the top


    Powered by Savane 3.1-cleanup1