Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#120 Survey of class library : changes since 3.2.0

4.0.0
closed
Mark Miesfeld
None
5
2012-08-14
2009-01-06
jfaucher
No

Hi,

This is not (yet :-) a patch for documentation, only a helper script to list the changes in the ooRexx classes since 3.2.0. See Diff-3.2.0-4.0.0.htm for the list of changes.
I see that readme.pdf contains a section "About 3.1.2", maybe we can add a section "About 4.0.0" ?

I remember the feedback from Rick on 2008-07-20 :
A couple other changes that don't show up with just a survey of class
libraries:

1) The new ::CONSTANT directive
2) The new LIBRARY keyword on the ::REQUIRES directive.
3) The EXTERNAL option on ::ROUTINE to allow you to declare routines
as residing in a native library
4) The new object oriented APIs
5) Multiple references to ::REQUIRES files will resolve to just a
single loaded instance of the file rather than
reloading the file for each reference.
6) The steam class supports files larger than 4GB.

I don't know if you have a way to build a relase notes from SVN...
If nobody is working on this list of changes, I volunteer to build it.

Jean-Louis

Discussion

  • Rick McGuire
    Rick McGuire
    2009-01-18

    Thank you for this. It helped me find a couple of missed doc updates. If you wish to find all of the bugs, rfes, etc in the new release, just do a Tracker search on the 4.0.0 group or the 3.3 group. This would be great if you're willing to start pulling together the changes doc.

     
  • Mark Miesfeld
    Mark Miesfeld
    2009-01-18

    Jean-Louis,

    I had also meant to add a comment when you first opened this. It would be great if you worked on updating the CHANGES doc.

    To add to what Rick said about finding all the bugs, etc. In general I think we have been trying to put the tracker item in the 'pending' state when a change is actually commited that will make it into the next release. So a search for all pending items in the 4.0.0 or 3.3 group should give you most of the items that need to go into the CHANGES doc.

    And if you want to work on the read me doc that to would be good. Discussing what should and shouldn't go into the read me doc on the devel list will probably give you some guidance if you need it.

    I know all the developers would appreciate some help on this documentation.

     
  • jfaucher
    jfaucher
    2009-01-19

    Ok,

    I will start by the list of changes. I don't plan to build an exhaustive list of fixed bugs with their references (unless you want that ?) but rather a list of changes that a normal user can see when using ooRexx 4.0.
    Do you have already defined the deadline for the ooRexx 4.0 documentation ? Because I'm currently very busy at work, and won't have a lot of time for this task during this week and next week :-(

     
  • Mark Miesfeld
    Mark Miesfeld
    2009-01-19

    Jean-Louis,

    Actually, we do try to list all the fixed bugs and enhancements in the CHANGES file. It is in the root of the source tree. The one for 4.0.0 is already started a little. The format is easy enough, it is just the tracker number and the verbatim title of the item:

    All Platforms

    • 1856576 - bug with multiple time('r') calls on same instruction.

    • 1856717 - lines( , "") should not be valid

    • 1858730 - empty method does not empty after append
      ...

    That is where doing a search for all 'pending' items comes in handy. When 4.0.0 is actually released, we will change all the pending items to closed. When 3.2.0 was released, all the pending itmes were closed, so what is now pending should all be for this release.

    What I would like to see for this release is, either in a release notes file, or maybe in the readme, is a brief discussion of the changes the normal user will see and what to look for. Rather than a verbatim list of bug titles, it would be more convesational. For example there are a number of different bugs and some RFEs pending concerning the Windows samples. You could cover them all in a single sentence, something like:

    The Windows samples have been upgraded to work better on Vista with a number of small enhancements added.

    Then a user interested in the samples would know to take a fresh look at them, or to look closely through the changes document for items releated to the samples.

    Any help you can give is appreciated. We are all very busy at work right now and the release is not going to happen this month.

    Thanks.

     
  • Mark Miesfeld
    Mark Miesfeld
    2009-04-07

    Jean-Louis supplied a nice document that I used as the basis for the release notes and used to update the readme.pdf document. I think that pretty much takes care of this item so I'm closing it out.

     


Anonymous


Cancel   Add attachments