add some things to release notes and changes.html; revise README

Tom Henderson 2008-12-05 13:11:26 -08:00
parent 4dc33672ac
commit e1443a1660
3 changed files with 66 additions and 66 deletions

View File

@ -48,6 +48,11 @@ us a note on ns-developers mailing list. </p>
<h2>new API:</h2>
<ul>
<li> ns-3 ABORT macros in src/core/abort.h</li>
<li> Config::MatchContainer </li>
<li> ConstCast and DynamicCast helper functions for Ptr casting</li>
<li> StarTopology added to several topology helpers </li>
<li> NetDevice::IsBridge () </li>
<li>17-11-2008; changeset
<a href="http://code.nsnam.org/ns-3-dev/rev/4c1c3f6bcd03">4c1c3f6bcd03</a></li>
@ -67,10 +72,6 @@ scenarios. See src/devices/emu and examples/emu-udp-echo.cc for details.
</li>
</ul>
</ul>
<h2>new API in existing classes:</h2>
<ul>
<li>17-11-2008; changeset
<a href="http://code.nsnam.org/ns-3-dev/rev/4222173d1e6d">4222173d1e6d</a></li>
<ul>
@ -84,6 +85,38 @@ hook ascii trace to the drop trace events in Ipv4L3Protocol and ArpL3Protocol.
<h2>changes to existing API:</h2>
<ul>
<li> NetDevice::MakeMulticastAddress() was renamed to NetDevice::GetMulticast()
and the original GetMulticast() removed </li>
<li> Socket API changes:
<ul>
<li> return type of SetDataSentCallback () changed from bool to void </li>
<li> Socket::Listen() no longer takes a queueLimit argument</li>
</ul>
<li> As part of the Wifi Phy rework, there have been several API changes
at the low level and helper API level. </li>
<ul>
<li> At the helper API level, the WifiHelper was split to three classes:
a WifiHelper, a YansWifiChannel helper, and a YansWifiPhy helper. Some
functions like Ascii and Pcap tracing functions were moved from class
WifiHelper to class YansWifiPhyHelper.
<li> At the low-level API, there have been a number of changes to
make the Phy more modular:</li>
<ul>
<li> composite-propagation-loss-model.h is removed</li>
<li> DcfManager::NotifyCcaBusyStartNow() has changed name</li>
<li> fragmentation related functions (e.g. DcaTxop::GetNFragments()) have
changed API to account for some implementation changes</li>
<li> Interference helper and error rate model added </li>
<li> JakesPropagationLossModel::GetLoss() moved to PropagationLoss() class</li>
<li> base class WifiChannel made abstract </li>
<li> WifiNetDevice::SetChannel() removed </li>
<li> a WifiPhyState helper class added </li>
<li> addition of the YansWifiChannel and YansWifiPhy classes </li>
</ul>
</ul>
<li>17-11-2008; changeset
<a href="http://code.nsnam.org/ns-3-dev/rev/dacfd1f07538">dacfd1f07538</a></li>
<ul>
@ -113,6 +146,7 @@ assignment of /32 addresses.
Global routing supports bridge devices.
</li>
</ul>
</ul>
<hr>
<h1>changes from ns-3.1 to ns-3.2</h1>

80
README
View File

@ -5,19 +5,21 @@
Table of Contents:
------------------
1) An Open Source project
2) An overview of the ns-3 project
3) Building ns-3
4) Running ns-3
5) Getting access to the ns-3 documentation
6) Working with the development version of ns-3
1) An overview
2) Building ns-3
3) Running ns-3
4) Getting access to the ns-3 documentation
5) Working with the development version of ns-3
Note: Much more substantial information about ns-3 can be found at
http://www.nsnam.org
1) An Open Source project
-------------------------
ns-3 is an Open Source project. We intend to make this
project a successful collaborative project: we hope that
ns-3 is a free open source project aiming to build a discrete-event
network simulator targeted for simulation research and education.
This is a collaborative project; we hope that
the missing pieces of the models we have not yet implemented
will be contributed by the community in an open collaboration
process.
@ -31,38 +33,7 @@ Despite this lack of a formal process, there are a number of
steps which naturally stem from the open-source roots of the
project. These steps are described in doc/contributing.txt
2) An overview of the ns-3 project
----------------------------------
This package contains the latest version of ns-3 which aims
at being a replacement for ns-2. Currently, ns-3 provides a
number of simple network simulation models:
- an ipv4 and tcp and udp stack
- arp support at the bottom of the stack
- static global and OLSR unicast routing
- point-to-point, CSMA, and Wifi links
- mobility
- OnOff traffic generator
Our focus to date has been on getting an overall software
framework in place. The framework is there to make adding
new models as simple as possible:
- an extensive callback-based tracing system
- simple file trace serialization support is included
to both text and pcap files.
- an attribute system for configuring parameters in the
models
- adding new MAC-level models simply requires subclassing
the pair of classes NetDevice and Channel.
- adding new traffic generation algorithms is also very
simple through the Application and the Socket classes.
3) Building ns-3
2) Building ns-3
----------------
The code for the framework and the default models provided
@ -76,34 +47,17 @@ tool 'waf'. Detailed information on how use waf is
included in the file doc/build.txt
However, the real quick and dirty way to get started is to
type the command "./waf" the the directory which contains
type the command "./waf configure; ./waf" the the directory which contains
this README file. The files built will be copied in the
build/debug or build/optimized.
The current codebase is expected to build and run on the
following set of platforms:
- linux x86 gcc 4.2, 4.1, and, 3.4.6.
- linux x86_64 gcc 4.1.3, 4.2.1, 3.4.6
- MacOS X ppc and x86
- mingw gcc 3.4.5 (debug only)
- cygwin gcc 3.4.4 (debug only)
The current codebase is expected to fail to build on
the following platforms:
- gcc 3.3 and earlier
- optimized builds on gcc 3.4.4 and 3.4.5
- optimized builds on linux x86 gcc 4.0
- msvc
The following optional features are known to not work on
these platforms:
- mingw: nsc, realtime scheduler
- cygwin: python bindings, nsc
set of platforms listed in the RELEASE_NOTES file.
Other platforms may or may not work: we welcome patches to
improve the portability of the code to these other platforms.
4) Running ns-3
3) Running ns-3
---------------
On recent Linux systems, once you have built ns-3, it
@ -116,7 +70,7 @@ That program should generate a simple-global-routing.tr text
trace file and a set of simple-global-routing-xx-xx.pcap binary
pcap trace files, which can be read by tcpdump -tt -r filename.pcap
5) Getting access to the ns-3 documentation
4) Getting access to the ns-3 documentation
-------------------------------------------
Once you have verified that your build of ns-3 works by running
@ -131,6 +85,8 @@ include some of it in this release for ease of use.
This documentation includes:
- a tutorial
- a manual
- a wiki for user-contributed tips: http://www.nsnam.org/wiki/
@ -139,7 +95,7 @@ This documentation includes:
as introductory text:
http://www.nsnam.org/doxygen/index.html
6) Working with the development version of ns-3
5) Working with the development version of ns-3
-----------------------------------------------
If you want to download and use the development version

View File

@ -42,6 +42,16 @@ New user-visible features
New clases to support IPv6 addresses has been added to the system. This
is enabling technology for fuller IPv6 support scheduled for ns-3.4.
d) A flow-id tag has been added to the contributed code section
e) Star topologies can be created from the topology helper functions
f) The global routing code has been made dynamic (not just limited to
(pre-simulation computation) and supports stub network interfaces and
bridge net devices
g) A MatchContainer has been added to the configuration subsystem
API changes from ns-3.2
-----------------------
API changes for this release are documented in the file CHANGES.html