diff options
author | Nathan Skrzypczak <nathan.skrzypczak@gmail.com> | 2021-08-19 11:38:06 +0200 |
---|---|---|
committer | Dave Wallace <dwallacelf@gmail.com> | 2021-10-13 23:22:32 +0000 |
commit | 9ad39c026c8a3c945a7003c4aa4f5cb1d4c80160 (patch) | |
tree | 3cca19635417e28ae381d67ae31c75df2925032d /docs/aboutvpp/releasenotes/v17.01.rst | |
parent | f47122e07e1ecd0151902a3cabe46c60a99bee8e (diff) |
docs: better docs, mv doxygen to sphinx
This patch refactors the VPP sphinx docs
in order to make it easier to consume
for external readers as well as VPP developers.
It also makes sphinx the single source
of documentation, which simplifies maintenance
and operation.
Most important updates are:
- reformat the existing documentation as rst
- split RELEASE.md and move it into separate rst files
- remove section 'events'
- remove section 'archive'
- remove section 'related projects'
- remove section 'feature by release'
- remove section 'Various links'
- make (Configuration reference, CLI docs,
developer docs) top level items in the list
- move 'Use Cases' as part of 'About VPP'
- move 'Troubleshooting' as part of 'Getting Started'
- move test framework docs into 'Developer Documentation'
- add a 'Contributing' section for gerrit,
docs and other contributer related infos
- deprecate doxygen and test-docs targets
- redirect the "make doxygen" target to "make docs"
Type: refactor
Change-Id: I552a5645d5b7964d547f99b1336e2ac24e7c209f
Signed-off-by: Nathan Skrzypczak <nathan.skrzypczak@gmail.com>
Signed-off-by: Andrew Yourtchenko <ayourtch@gmail.com>
Diffstat (limited to 'docs/aboutvpp/releasenotes/v17.01.rst')
-rw-r--r-- | docs/aboutvpp/releasenotes/v17.01.rst | 99 |
1 files changed, 99 insertions, 0 deletions
diff --git a/docs/aboutvpp/releasenotes/v17.01.rst b/docs/aboutvpp/releasenotes/v17.01.rst new file mode 100644 index 00000000000..0f22fa782ff --- /dev/null +++ b/docs/aboutvpp/releasenotes/v17.01.rst @@ -0,0 +1,99 @@ +Release notes for VPP 17.01 +=========================== + +@note This release was for a while known as 16.12. + +Features +-------- + +- `Integrated November 2016 DPDK release <http://www.dpdk.org/doc/guides/rel_notes/release_16_11.html>`__ + +- Complete rework of Forwarding Information Base (FIB) + +- Performance Improvements + + - Improvements in DPDK input and output nodes + - Improvements in L2 path + - Improvmeents in IPv4 lookup node + +- Feature Arcs Improvements + + - Consolidation of the code + - New feature arcs + + - device-input + - interface-output + +- DPDK Cryptodev Support + + - Software and Hardware Crypto Support + +- DPDK HQoS support + +- Simple Port Analyzer (SPAN) + +- Bidirectional Forwarding Detection + + - Basic implementation + +- IPFIX Improvements + +- L2 GRE over IPSec tunnels + +- Link Layer Discovery Protocol (LLDP) + +- Vhost-user Improvements + + - Performance Improvements + - Multiqueue + - Reconnect + +- LISP Enhancements + + - Source/Dest control plane support + - L2 over LISP and GRE + - Map-Register/Map-Notify/RLOC-probing support + - L2 API improvements, overall code hardening + +- Plugins: + + - New: ACL + - New: Flow per Packet + - Improved: SNAT + + - Mutlithreading + - Flow export + +- Doxygen Enhancements + +- Luajit API bindings + +- API Refactoring + + - file split + - message signatures + +- Python and Scapy based unit testing infrastructure + + - Infrastructure + - Various tests + +- Packet Generator improvements + +- TUN/TAP jumbo frames support + +- Other various bug fixes and improvements + +Known issues +------------ + +For the full list of issues please refer to fd.io +`JIRA <https://jira.fd.io>`__. + +Issues fixed +------------ + +For the full list of fixed issues please refer to: + +- fd.io `JIRA <https://jira.fd.io>`__ +- git `commit log <https://git.fd.io/vpp/log/?h=stable/1701>`__ |