blob: 7205cd505d74316129798e5c93c5af297a7f5150 [file] [log] [blame] [view]
Alexander Afanasyev339161a2016-10-27 22:41:16 +00001Release Notes
2=============
3
susmit48cb0b62018-02-13 12:27:24 -07004## Version 0.6
5
6chunks:
7- include RTT stats in final summary
8- respect `--retries=-1` in AIMD pipeline
9- change the default pipeline to AIMD
10- react to congestion marks by default as a timeout event (can be disabled using
11 `--aimd-ignore-cong-marks`)
12- print a final summary of the transfer regardless of the pipeline type, and even if
13 `--verbose` was not specified
14
Alexander Afanasyeveacd6172017-10-16 16:40:31 -040015## Version 0.5
16
17all:
18- Switch to version 2 of certificates, `KeyChain`, and `Validator` (Issue #4089)
19- Compilation fixes (Issue #4259)
20
21peek:
22- Convert use of `Link` into `ForwardingHint` (Issue #4055)
23
24chunks:
25- Make `ndnputchunks` display some output by default. A new `-q` flag makes output
26 completely silent, except for errors (Issue #4286)
27- Refactor `ndnputchunks` options handling
28- Reduce initial timeout of iterative version discovery in `ndncatchunks` (Issue #4291)
29- Fix potential `ndncatchunks` crash on exit
30
Alexander Afanasyev339161a2016-10-27 22:41:16 +000031## Version 0.4
32
33**NOTE**
34
35 As of version 0.4, NDN Essential Tools require a modern compiler (gcc >= 4.8.2, clang >= 3.4)
36 and a relatively new version of the Boost libraries (>= 1.54). This means that the code no
37 longer compiles with the packaged version of gcc and Boost libraries on Ubuntu 12.04.
38 NDN Essential Tools can still be compiled on such systems, but require a separate
39 installation of a newer version of the compiler (e.g., clang-3.4) and dependencies.
40
41chunks:
42- Change default version discovery to `iterative`
43- Improve help text of `ndnputchunks`
44- Fix `DiscoverVersionIterative` build error
45- Modularize Interest pipeline implementation
46- Add AIMD congestion control (Issue #3636)
47- Code cleanup and improvements
48
49dissect-wireshark:
50- Add initial support for NDNLPv2 (Issue #3197)
51- Fix potential memory overflow
52
53dump:
54- Add support for Linux cooked-mode capture (SLL) (Issue #3061)
55- Improve error messages
56
57pib:
58- Disable by default (can be compiled with ndn-cxx version 0.5.0)
59- Fix compilation error with new version of ndn-cxx library
60- Avoid use of deprecated block helpers
61- Correct build target path
62
63ping:
64- Recognize and trace NACK
65- Fix potential divide-by-zero bug in StatisticsCollector (Issue #3504)
66
67peek:
68- Recognize and properly handle NACK
69- Refactor implementation
70
71## Version 0.3
72
73chunks: **New** (pair of) tool(s) for segmented file transfer
74
75peek:
76- Allow verbose output
77- Switch from `getopt` to `boost::program_options`
78- Add `--link-file` option
79
80ping:
81- Document ndnping protocol
82
83dump:
84- Capture and print network NACK packets
85- Update docs to include NACK capture feature
86
87build scripts:
88- Enable -Wextra by default
89- Fix missing tool name in `configure --help` output
90- Fix compatibility with Python 3
91
92## Version 0.2
93
94Code improvements and new tools:
95
96- PIB service to manage the public information of keys and publish certificates
97 (Issue 3018)
98- A Wireshark dissector for NDN packets (Issue 3092)
99
100## Version 0.1
101
102Initial release of NDN Essential Tools, featuring:
103
104- ndnpeek, ndnpoke: a pair of programs to request and make available for
105 retrieval of a single Data packet
106- ndnping, ndnpingserver: reachability testing tools for Named Data Networking
107- ndndump: a traffic analysis tool that captures Interest and Data packets on
108 the wire
109- ndn-dissect: an NDN packet format inspector. It reads zero or more NDN
110 packets from either an input file or the standard input, and displays the
111 Type-Length-Value (TLV) structure of those packets on the standard output.