Difference between revisions of "Ns-3.11"

From Nsnam
Jump to: navigation, search
(ns-3.11 work items)
Line 1: Line 1:
 
{{TOC}}
 
{{TOC}}
This page summarizes the ongoing release planning for ns-3.11.
+
This page summarizes the ongoing release planning for ns-3.11. Josh Pelkey <jpelkey@gatech.edu> will manage the release.
  
 
= Proposed Release Schedule =
 
= Proposed Release Schedule =
  
ns-3.11 should be released in the April 2011 timeframe.
+
# January 5 -- ns-3.10 posted
 +
# January 5 -- ns-3.11 '''''Open phase begins'''''
 +
# February 14 -- Deadline for new feature merge
 +
# February 14 -- Begin the phase of small feature development and bug fixing
 +
# March 5 -- Small feature development and bug fixing ends
 +
# March 5 -- '''''Open phase ends'''''
 +
# March 5 -- '''''Maintenance phase begins'''''
 +
# March 30 -- '''''Maintenance phase ends'''''
 +
# March 30 -- '''''Code freeze phase begins'''''
 +
# March 30 -- ns-3.11-RC1
 +
# April 4 -- ns-3.11-RC2
 +
# April 7 -- ns-3.11-RC3
 +
# April 11    -- ns-3.11 posted
 +
# April 11    -- '''''Code freeze phase ends'''''
 +
# April 11    -- ns-3.12 Open phase begins
  
= Possible work for ns-3.11 =
+
As described in the [[Roadmap]] there are three broad sections in the release schedule.  During the open phase, people wanting to include a new feature in ns-3.11 should contact Josh and arrange to have their features merged into ns-3-dev.  You will be expected to provide the following:
  
== New features ==
+
* A mercurial patch, bundle or repo against the current version of ns-3-dev that contains your proposed feature addition.  You need to make sure that we can apply this patch and build and run (debug and optimized as appropriate) all unit and regression tests successfully on all of our target machines
 +
* A summary of the additions you are proposing and an explanation of any changes to existing code that had to be done in order to support your feature (this will be used to generate release notes and will be provided to maintainers if a code review is indicated)
 +
* Some kind of unit or system test that can be used to determine if your feature is actually working at each stage of the integration
 +
 
 +
One of us will take a quick look at your proposed addition and determine if a code review is required.  According to the ''book of instructions'' a code review requiring positive acknowledgment by maintainers is indicated if:
 +
 
 +
* Your proposed feature does not work with all models or on all platforms
 +
* Your feature changes pre-existing APIs
 +
* Your feature crosses maintainer boundaries
 +
 
 +
Just to be safe, we will probably run a feature submission by at least one maintainer according to the general area of applicability of the feature.  For example, if you submit an entirely new device driver model, as a courtesy we will run this submission by the maintainers of the current devices.  The maintainers won't have any responsibility to positively ack the submission, but we will take some time to allow a reasonable review.
 +
 
 +
The open phase is divided into two parts: new feature merge period and small feature development and bug fixing.
 +
 
 +
During the new feature merge period we can:
 +
* Review the code that might be merged
 +
* Clean up the bug tracker: solve as much bugs as possible
 +
* Merge the new features that has +1 and from maintainers
 +
 
 +
After February 14th, the new feature merge period ends and small feature development and bug fixes begins. During the latter, no more merges are accepted and we can:
 +
* Accept limited, small, self contained changes/features to ns-3-dev and to merged new features. As specified before, no more merges are accepted
 +
* Review the code to be merged for next releases
 +
* Cleanup the ns-3-dev bug tracker, solve as much bugs as possible
 +
 
 +
The end of the  small feature development and bug fixes coincides (March 5th) with the beginning of the maintenance phase.  No new features may be added, but the maintainers may check in fixes to bugs; and people with new features that have been accepted and previously merged may fix bugs in existing features.  Please don't try to sneak in more new features or you may have your whole feature set removed at the release manager's discretion.  You can ask if you want to add small, self-contained features, but there are no guarantees that we will okay them.
 +
 
 +
On March 30th, 2011, we are going to enter the code freeze phase.  This indicates that we are in the final stages of the release and our primary goal is stability.  During the code freeze phase, only P1 bugfixes will be allowed to be checked in.  Our ''goal'' will be to reduce the number of P1 bugs to zero before the release of ns-3.11.
 +
 
 +
'''''We will reserve the right to veto (and remove) any new feature addition if it begins to cause problems and looks like it threatens the stability of the release at any time in the release process.'''''
 +
 
 +
= Candidate Contributions for Inclusion in ns-3.11 =
  
 
* [http://codereview.appspot.com/1690056/show ns-3 click]
 
* [http://codereview.appspot.com/1690056/show ns-3 click]
Line 24: Line 68:
 
* [http://codereview.appspot.com/850045/show MPLS]
 
* [http://codereview.appspot.com/850045/show MPLS]
 
* [http://mailman.isi.edu/pipermail/ns-developers/2010-February/007419.html TCP Vegas] (blocked by lack of progress on TCP congestion control architecture)
 
* [http://mailman.isi.edu/pipermail/ns-developers/2010-February/007419.html TCP Vegas] (blocked by lack of progress on TCP congestion control architecture)
 +
* [http://codereview.appspot.com/3374041/ NetAnim trace hooks for wireless]
 +
 +
= ns-3.11 Features Merged =
 +
*
  
== Priority bugs ==
+
= The ns-3.11 Bug List =
  
 
* bug 445 Class name rename Scalar->Dimensionless (issue 445) http://www.nsnam.org/bugzilla/show_bug.cgi?id=445
 
* bug 445 Class name rename Scalar->Dimensionless (issue 445) http://www.nsnam.org/bugzilla/show_bug.cgi?id=445
Line 34: Line 82:
 
** needs further testing and verification
 
** needs further testing and verification
  
== Feature requests ==
+
= Feature requests =
  
 
* make spectrum model compatible with ns-3 WiFi
 
* make spectrum model compatible with ns-3 WiFi
 
* ns-2 packet UID feature  
 
* ns-2 packet UID feature  
 
* API for TOS bytes (issue 897)  ''may wait for netfilter support''
 
* API for TOS bytes (issue 897)  ''may wait for netfilter support''
* [http://codereview.appspot.com/3374041/ NetAnim trace hooks for wireless]
 
 
* Chord/DHT (authors are planning to revise code based on comments)
 
* Chord/DHT (authors are planning to revise code based on comments)
 
* app store and build system refactoring
 
* app store and build system refactoring

Revision as of 20:39, 14 January 2011

Main Page - Current Development - Developer FAQ - Tools - Related Projects - Project Ideas - Summer Projects

Installation - Troubleshooting - User FAQ - HOWTOs - Samples - Models - Education - Contributed Code - Papers

This page summarizes the ongoing release planning for ns-3.11. Josh Pelkey <jpelkey@gatech.edu> will manage the release.

Proposed Release Schedule

  1. January 5 -- ns-3.10 posted
  2. January 5 -- ns-3.11 Open phase begins
  3. February 14 -- Deadline for new feature merge
  4. February 14 -- Begin the phase of small feature development and bug fixing
  5. March 5 -- Small feature development and bug fixing ends
  6. March 5 -- Open phase ends
  7. March 5 -- Maintenance phase begins
  8. March 30 -- Maintenance phase ends
  9. March 30 -- Code freeze phase begins
  10. March 30 -- ns-3.11-RC1
  11. April 4 -- ns-3.11-RC2
  12. April 7 -- ns-3.11-RC3
  13. April 11 -- ns-3.11 posted
  14. April 11 -- Code freeze phase ends
  15. April 11 -- ns-3.12 Open phase begins

As described in the Roadmap there are three broad sections in the release schedule. During the open phase, people wanting to include a new feature in ns-3.11 should contact Josh and arrange to have their features merged into ns-3-dev. You will be expected to provide the following:

  • A mercurial patch, bundle or repo against the current version of ns-3-dev that contains your proposed feature addition. You need to make sure that we can apply this patch and build and run (debug and optimized as appropriate) all unit and regression tests successfully on all of our target machines
  • A summary of the additions you are proposing and an explanation of any changes to existing code that had to be done in order to support your feature (this will be used to generate release notes and will be provided to maintainers if a code review is indicated)
  • Some kind of unit or system test that can be used to determine if your feature is actually working at each stage of the integration

One of us will take a quick look at your proposed addition and determine if a code review is required. According to the book of instructions a code review requiring positive acknowledgment by maintainers is indicated if:

  • Your proposed feature does not work with all models or on all platforms
  • Your feature changes pre-existing APIs
  • Your feature crosses maintainer boundaries

Just to be safe, we will probably run a feature submission by at least one maintainer according to the general area of applicability of the feature. For example, if you submit an entirely new device driver model, as a courtesy we will run this submission by the maintainers of the current devices. The maintainers won't have any responsibility to positively ack the submission, but we will take some time to allow a reasonable review.

The open phase is divided into two parts: new feature merge period and small feature development and bug fixing.

During the new feature merge period we can:

  • Review the code that might be merged
  • Clean up the bug tracker: solve as much bugs as possible
  • Merge the new features that has +1 and from maintainers

After February 14th, the new feature merge period ends and small feature development and bug fixes begins. During the latter, no more merges are accepted and we can:

  • Accept limited, small, self contained changes/features to ns-3-dev and to merged new features. As specified before, no more merges are accepted
  • Review the code to be merged for next releases
  • Cleanup the ns-3-dev bug tracker, solve as much bugs as possible

The end of the small feature development and bug fixes coincides (March 5th) with the beginning of the maintenance phase. No new features may be added, but the maintainers may check in fixes to bugs; and people with new features that have been accepted and previously merged may fix bugs in existing features. Please don't try to sneak in more new features or you may have your whole feature set removed at the release manager's discretion. You can ask if you want to add small, self-contained features, but there are no guarantees that we will okay them.

On March 30th, 2011, we are going to enter the code freeze phase. This indicates that we are in the final stages of the release and our primary goal is stability. During the code freeze phase, only P1 bugfixes will be allowed to be checked in. Our goal will be to reduce the number of P1 bugs to zero before the release of ns-3.11.

We will reserve the right to veto (and remove) any new feature addition if it begins to cause problems and looks like it threatens the stability of the release at any time in the release process.

Candidate Contributions for Inclusion in ns-3.11

ns-3.11 Features Merged

The ns-3.11 Bug List

Feature requests

  • make spectrum model compatible with ns-3 WiFi
  • ns-2 packet UID feature
  • API for TOS bytes (issue 897) may wait for netfilter support
  • Chord/DHT (authors are planning to revise code based on comments)
  • app store and build system refactoring
  • fragmentation for IPv4: being worked by Vedran Miletic
  • TDMA wireless model
    • being worked on by Hemanth Narra