Report: versioning
[csit.git] / docs / report / introduction / report_history.rst
index e6fb910..47be05c 100644 (file)
@@ -1,16 +1,89 @@
-Report History
-==============
+Document History
+================
+
+The version of this document is expressed as: **CSIT-YYMM.WW** where YY is the
+year, MM is the month and WW is the calendar week.
 
 +---------+--------------------------------------------------------------------+
 | Version | Change                                                             |
 +=========+====================================================================+
-| 1.1     | - Add dot1q KVM VMs vhost-user tests to the VPP performance        |
-|         |   graphs.                                                          |
-|         | - Add the information about the number of runs used to generate    |
-|         |   the plots.                                                       |
-|         | - Add the test results:                                            |
-|         |   - K8s Container Memif,                                           |
-|         |   - VPP on 3n-hsw testbed.                                         |
+| .48     | 1. Added configurations for Denverton:                             |
+|         |                                                                    |
+|         |    a. Packet throughput :ref:`vpp_perf_configurations_2n_dnv`      |
+|         |    b. MRR :ref:`vpp_mrr_configurations_2n_dnv`                     |
+|         |                                                                    |
+|         | 2. Added operational data for Denverton:                           |
+|         |                                                                    |
+|         |    a. Packet throughput :ref:`vpp_perf_operational_2n_dnv`         |
+|         |                                                                    |
+|         | 3. Added graphs for Denverton:                                     |
+|         |                                                                    |
+|         |    a. Packet Throughput - L2 Switching -                           |
+|         |       :ref:`packet_throughput_graphs_l2sw-2n-dnv-x553`             |
+|         |    b. Packet Throughput - IPv4 Routing -                           |
+|         |       :ref:`packet_throughput_graphs_ip4-2n-dnv-x553`              |
+|         |    c. Packet Throughput - IPv6 Routing -                           |
+|         |       :ref:`packet_throughput_graphs_ip6-2n-dnv-x553`              |
+|         |    d. Speedup Multi-Core - L2 Switching -                          |
+|         |       :ref:`speedup_graphs_l2sw-2n-dnv-x553`                       |
+|         |    e. Speedup Multi-Core - IPv4 Routing -                          |
+|         |       :ref:`speedup_graphs_ip4-2n-dnv-x553`                        |
+|         |    f. Speedup Multi-Core - IPv6 Routing -                          |
+|         |       :ref:`speedup_graphs_ip6-2n-dnv-x553`                        |
+|         |                                                                    |
+|         | 4. Replaced old Denverton data with new data delivered on Nov-27.  |
+|         |                                                                    |
+|         | 5. Changed versioning of this document, see description on the top |
+|         |    of this page.                                                   |
+|         |                                                                    |
++---------+--------------------------------------------------------------------+
+| .w47    | 1. Added automated wrapping of long test names in graphs.          |
+|         | 2. Changed data and time format in the header.                     |
+|         | 3. Changed versioning.                                             |
+|         | 4. Added more test runs:                                           |
+|         |                                                                    |
+|         |    a. HoneyComb Functional.                                        |
+|         |    b. VPP on 3n-hsw testbed.                                       |
+|         |                                                                    |
+|         | 5. Added 3n-skx and 2n-skx comparisons to Report:                  |
+|         |                                                                    |
+|         |    a. VPP Performance Tests:                                       |
+|         |       :ref:`vpp_compare_current_vs_previous_release`               |
+|         |    b. DPDK Performance Tests:                                      |
+|         |       :ref:`dpdk_compare_current_vs_previous_release`              |
+|         |                                                                    |
+|         | 6. Changed title of this chapter to "Document History"             |
+|         | 7. Added comparisons between topologies:                           |
+|         |                                                                    |
+|         |    a. VPP: :ref:`vpp_compare_topologies_3n-Skx_vs_2n-Skx`          |
+|         |    b. DPDK: :ref:`dpdk_compare_topologies_3n-Skx_vs_2n-Skx`        |
+|         |                                                                    |
+|         | 8. Added results for Denverton:                                    |
+|         |                                                                    |
+|         |    a. Packet throughput :ref:`vpp_performance_results_2n_dnv`      |
+|         |    b. MRR :ref:`vpp_mrr_results_2n_dnv`                            |
+|         |                                                                    |
+|         | 9. Added the chapter "2-Node Atom Denverton (2n-dnv)" to           |
+|         |    :ref:`tested_physical_topologies`                               |
+|         |                                                                    |
+|         | 10. Added the chapter "Calibration Data - Denverton" to            |
+|         |     :ref:`vpp_test_environment`                                    |
+|         |                                                                    |
++---------+--------------------------------------------------------------------+
+| .w46    | 1. dot1q KVM VMs vhost-user tests added to                         |
+|         |    :ref:`KVM_VMs_vhost`.                                           |
+|         |                                                                    |
+|         | 2. Added number of test runs used to generate data for all graphs  |
+|         |                                                                    |
+|         |    a. :ref:`VPP_Packet_Throughput`                                 |
+|         |    b. :ref:`throughput_speedup_multi_core`                         |
+|         |    c. :ref:`VPP_Packet_Latency`                                    |
+|         |                                                                    |
+|         | 3. Added more test runs:                                           |
+|         |                                                                    |
+|         |    a. K8s Container Memif,                                         |
+|         |    b. VPP on 3n-hsw testbed.                                       |
+|         |                                                                    |
++---------+--------------------------------------------------------------------+
+| .w45    | Initial version                                                    |
 +---------+--------------------------------------------------------------------+
-| 1.0     | Initial version                                                    |
-+---------+--------------------------------------------------------------------+
\ No newline at end of file