doc/guides/rel_notes/release_2_3.rst

   1 DPDK Release 2.3
   2 ================
   3
   4
   5 **Read this first**
   6
   7 The text below explains how to update the release notes.
   8
   9 Use proper spelling, capitalization and punctuation in all sections.
  10
  11 Variable and config names should be quoted as fixed width text: ``LIKE_THIS``.
  12
  13 Build the docs and view the output file to ensure the changes are correct::
  14
  15    make doc-guides-html
  16
  17    firefox build/doc/html/guides/rel_notes/release_2_3.html
  18
  19
  20 New Features
  21 ------------
  22
  23 This section should contain new features added in this release. Sample format:
  24
  25 * **Add a title in the past tense with a full stop.**
  26
  27   Add a short 1-2 sentence description in the past tense. The description
  28   should be enough to allow someone scanning the release notes to understand
  29   the new feature.
  30
  31   If the feature adds a lot of sub-features you can use a bullet list like this.
  32
  33   * Added feature foo to do something.
  34   * Enhanced feature bar to do something else.
  35
  36   Refer to the previous release notes for examples.
  37
  38
  39 Resolved Issues
  40 ---------------
  41
  42 This section should contain bug fixes added to the relevant sections. Sample format:
  43
  44 * **code/section Fixed issue in the past tense with a full stop.**
  45
  46   Add a short 1-2 sentence description of the resolved issue in the past tense.
  47   The title should contain the code/lib section like a commit message.
  48   Add the entries in alphabetic order in the relevant sections below.
  49
  50
  51 EAL
  52 ~~~
  53
  54
  55 Drivers
  56 ~~~~~~~
  57
  58
  59 Libraries
  60 ~~~~~~~~~
  61
  62
  63 Examples
  64 ~~~~~~~~
  65
  66
  67 Other
  68 ~~~~~
  69
  70
  71 Known Issues
  72 ------------
  73
  74 This section should contain new known issues in this release. Sample format:
  75
  76 * **Add title in present tense with full stop.**
  77
  78   Add a short 1-2 sentence description of the known issue in the present
  79   tense. Add information on any known workarounds.
  80
  81
  82 API Changes
  83 -----------
  84
  85 This section should contain API changes. Sample format:
  86
  87 * Add a short 1-2 sentence description of the API change. Use fixed width
  88   quotes for ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  89
  90
  91 ABI Changes
  92 -----------
  93
  94 * Add a short 1-2 sentence description of the ABI change that was announced in
  95   the previous releases and made in this release. Use fixed width quotes for
  96   ``rte_function_names`` or ``rte_struct_names``. Use the past tense.
  97
  98
  99 Shared Library Versions
 100 -----------------------
 101
 102 Update any library version updated in this release and prepend with a ``+`` sign.
 103
 104 The libraries prepended with a plus sign were incremented in this version.
 105
 106 .. code-block:: diff
 107
 108      libethdev.so.2
 109      librte_acl.so.2
 110      librte_cfgfile.so.2
 111      librte_cmdline.so.1
 112      librte_distributor.so.1
 113      librte_eal.so.2
 114      librte_hash.so.2
 115      librte_ip_frag.so.1
 116      librte_ivshmem.so.1
 117      librte_jobstats.so.1
 118      librte_kni.so.2
 119      librte_kvargs.so.1
 120      librte_lpm.so.2
 121      librte_mbuf.so.2
 122      librte_mempool.so.1
 123      librte_meter.so.1
 124      librte_pipeline.so.2
 125      librte_pmd_bond.so.1
 126      librte_pmd_ring.so.2
 127      librte_port.so.2
 128      librte_power.so.1
 129      librte_reorder.so.1
 130      librte_ring.so.1
 131      librte_sched.so.1
 132      librte_table.so.2
 133      librte_timer.so.1
 134      librte_vhost.so.2