updates to RELEASE_NOTES and CHANGES.html
authorTom Henderson <tomh@tomh.org>
Mon, 02 Feb 2015 21:06:56 -0800
changeset 11209 2ebe49d34182
parent 11208 22527b148290
child 11210 002836cb4ffc
updates to RELEASE_NOTES and CHANGES.html
CHANGES.html
RELEASE_NOTES
--- a/CHANGES.html	Mon Feb 02 16:18:19 2015 -0800
+++ b/CHANGES.html	Mon Feb 02 21:06:56 2015 -0800
@@ -54,6 +54,14 @@
 <h1>Changes from ns-3.21 to ns-3.22</h1>
 <h2>New API:</h2>
 <ul>
+  <li> New classes were added for the PARF and APARF WiFi rate controls. 
+  </li>
+  <li> Support for WiFi 802.11n MPDU aggregation has been added.
+  </li>
+  <li> Support for modeling of vehicular WiFi networks (IEEE 1609.4) has been added.  In addition, a basic safety message (BSM) application traffic generator and related statistics-gathering classes have been added to the wave module. 
+  </li>
+  <li> A complete LTE release bearer procedure is now implemented which can be invoked by calling the new helper method LteHelper::DeActivateDedicatedEpsBearer ().
+  </li>
   <li> It is now possible to print the Neighbor Cache (ARP and NDISC) by using
        the RoutingProtocolHelper
   </li>
@@ -61,6 +69,9 @@
        the stats module, enabling TracedValues emitting values of type 
        ns3::Time to be handled by the framework.
   </li>
+  <li> A new attribute 'ClockGranularity' was added to the TcpSocketBase class,
+to control modeling of RTO calculation.
+  </li>
 </ul>
 
 <h2>Changes to existing API:</h2>
@@ -83,6 +94,13 @@
        are similarly documented we have deprecated the three
        argument version of AddTraceSource.
   </li>	
+  <li> The "MinRTO" attribute of the RttEstimator class was moved to the TcpSocketBase class.  The "Gain" attribute of the RttMeanDeviation class was replaced 
+by new "Alpha" and "Beta" attributes.  
+  </li>	
+  <li> Attributes of the TcpTxBuffer and TcpRxBuffer class are now accessible through the TcpSocketBase class.
+  </li>	
+  <li> The LrWpanHelper class has a new constructor allowing users to configure a MultiModelSpectrumChannel as an option, and also provides Set/Get API to allow users to access the underlying channel object. 
+  </li>
 </ul>
 
 <h2>Changes to build system:</h2>
@@ -92,9 +110,12 @@
 </ul>
 
 <h2>Changed behavior:</h2>
+This section is for behavioral changes to the models that were not due to a bug fix.
 <ul>
   <li> The default value of the `Speed` attribute of ConstantSpeedPropagationDelayModel was changed from 300,000,000 m/s to 299,792,458 m/s (speed of light in a vacuum), causing propagation delays using this model to vary slightly.
   </li>
+  <li> The LrWpanHelper object was previously instantiating only a LogDistancePropagationLossModel on a SingleModelSpectrumChannel, but no PropagationDelayModel.  The constructor now adds by default a ConstantSpeedPropagationDelayModel.
+  </li>
 </ul>
 
 <hr>
--- a/RELEASE_NOTES	Mon Feb 02 16:18:19 2015 -0800
+++ b/RELEASE_NOTES	Mon Feb 02 21:06:56 2015 -0800
@@ -21,29 +21,37 @@
 
 New user-visible features
 -------------------------
-- It is now possible to print the Neighbor Cache (ARP and NDISC) by using
-  the RoutingProtocolHelper
-- The PrintRoutingTable... and PrintNeighborCache... are now static funtions
-  i.e., it's not anymore needed to instantiate an helper just to use them.
-- A new TimeProbe class has been added to hook the data collection framework
-  to traced values emitting Time objects
-- In previous releases of the LTE module, the bearer release
+- (wifi) Support for MPDU aggregation has been added to the wifi model, 
+  as well as a number of related example programs.
+- (wifi) PARF and APARF WiFi rate controls have been added to the wifi model.
+- (lte) In previous releases of the LTE module, the bearer release
   functionality was only partially supported. As an enhancement, a
   complete release bearer procedure is now implemented, which can be
   invoked by calling the new helper method
   LteHelper::DeActivateDedicatedEpsBearer(). The related output can be
   seen through the stats collected at different layers like PDCP, RLC,
-  MAC, PHY. To support this implementation, example and test suite is
+  MAC, PHY. To support this implementation, an example and test suite is
   added within the LTE module examples and tests folder.  
-
+- (wave) Support for WiFi-based vehicular communications using the 
+  IEEE 1609.4 framework has been added.  A Basic Safety Message (BSM) 
+  application packet generator, and associated statistics counters, has
+  been added.  A comprehensive VANET routing example has been added.
+- (internet) It is now possible to print the Neighbor Cache (ARP and NDISC) 
+  by using the RoutingProtocolHelper
+- (stats) A new TimeProbe class has been added to hook the data collection 
+  framework to traced values emitting Time objects
+- (documentation) the callback function signatures for all TraceSources
+  is documented in Doxygen
 
 Bugs fixed
 ----------
 - Bug 1405 - RttEstimator improvements
 - Bug 1551 - NS_LOG_COMPONENT_DEFINE inside or outside of ns3 namespace?
 - Bug 1726 - WiFi Minstrel rate control algorithm doesn't save state
+- Bug 1734 - TcpSocketBase produces spurious delayed ACKs
 - Bug 1758 - Yans and Nist error rate models for 5/6 code rate 802.11n HT
 - Bug 1770 - mesh test and example crash for 32-bit optimized builds
+- Bug 1774 - compute signal power around channel, not across whole band, and fix LrWpanHelper to add a default PropagationDelayModel
 - Bug 1791 - TCP Endpoint never deallocates when closing
 - Bug 1801 - Setting Wi-Fi timing parameters through WifiMac attributes (documentation fix)
 - Bug 1906 - 802.11n PHY configuration for 2.4GHz and 5GHz devices
@@ -55,6 +63,7 @@
 - Bug 1983 - FlowMonitor returns containers copies instead of references.
 - Bug 1986 - test result divergence for lte-frequency-reuse test
 - Bug 1991 - PcapFileWrapper::CaptureSize attribute (snaplen) has no effect.
+- Bug 1995 - avoid multiple definitions of PI
 - Bug 1996 - RSRQ calculation: misleading variable names
 - Bug 1997 - Fix PlotProbe() documentation and usage for GnuplotHelper and FileHelper
 - Bug 2002 - Hardcoded include paths cause breakage
@@ -69,10 +78,11 @@
 - Bug 2030 - provide default values for WifiTxVector
 - Bug 2037 - HT capabilities may print bogus chars
 - Bug 2038 - Stop method does not stop next wave in WaveformGenerator
-- Bug 2042 - src/lte/model/a3-rsrp-handover-algorithm.cc:137:79: error: overflow in implicit constant conversion
-- Bug 2043 - print-introspected-doxygen crashes when some modules are disabled default tip
+- Bug 2042 - LTE a3-rsrp-handover-algorithm.cc:  error: overflow in implicit constant conversion
+- Bug 2043 - print-introspected-doxygen crashes when some modules are disabled 
 - Bug 2044 - Buffer::Iterator::ReadNtohU16() and ReadNtohU32() not implemented correctly
 - Bug 2045 - Missing NS_OBJECT_ENSURE_REGISTERED in TcpTxBuffer and TcpRxBuffer
+- Bug 2046 - set Block Ack timeout when SetStandard is called
 - Bug 2047 - Ipv6EndPointDemux::Lookup may crash
 - Bug 2049 - CQI feedback should always use the same calculation method
 - Bug 2053 - In tcp-socket-base.cc, NotifyDataSent incorrectly called with retransmits
@@ -80,6 +90,8 @@
 
 Known issues
 ------------
+In general, known issues are tracked on the project tracker available
+at http://www.nsnam.org/bugzilla/
 
 Release 3.21
 ============