From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from out1-smtp.messagingengine.com (out1-smtp.messagingengine.com [66.111.4.25]) by dpdk.org (Postfix) with ESMTP id 2DE0A5B20 for ; Thu, 31 May 2018 23:11:31 +0200 (CEST) Received: from compute1.internal (compute1.nyi.internal [10.202.2.41]) by mailout.nyi.internal (Postfix) with ESMTP id B248D21BD5; Thu, 31 May 2018 17:11:30 -0400 (EDT) Received: from mailfrontend1 ([10.202.2.162]) by compute1.internal (MEProxy); Thu, 31 May 2018 17:11:30 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=monjalon.net; h= cc:date:from:message-id:subject:to:x-me-sender:x-me-sender :x-sasl-enc; s=mesmtp; bh=LYPd3dd1J0Y9JjcbGmfN5qlzRUfIapCuKhXE3X W25u4=; b=j/yXQ6c6r79OH2FY+YX1hGE2vy7OAXK0VEbGDq7BZa4Uke4LPHpDJ0 RDDcnqQYLQkJt5pmMWghV0O3QM/aSGLAYuU5GTDEWItJcQfw0FHK0C6vddgF0UfR 6pW2Xo1XAFgEEjYy/3elBsZmS3FULoZgVNktyj0HvMJU65Syn8Mg0= DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d= messagingengine.com; h=cc:date:from:message-id:subject:to :x-me-sender:x-me-sender:x-sasl-enc; s=fm2; bh=LYPd3dd1J0Y9JjcbG mfN5qlzRUfIapCuKhXE3XW25u4=; b=hPa7bP7PuoHfHKg9pwdUbWTg3cYq/0z3k xlfauRcQeL4V0Js3WLl+xb99a36SI2sI4J0EBpyyz0wIwPIgdU/kFNLei6OlsQ9u KLXFkuouPmIBudg1owS/Hy8SLKGfMWOS/sRiqjmDZg+1cIufuXGBrAZUn+CTao60 XNNvwipNXwcYIYrKfnrRby3OpQPWEiV7L17aQjLaf27IQDXRfRfrzcJGreunh7NQ Y44TFwPD71MXx0BK4EixqG991GRd52n3iD7i7Ax/luBgu4jT/Utu1Q+/i0eBrC9v RNEaP4wBE93UfouGoj1FrS+xLyx+VKMmxxtsGt1gdGTRP8/kQsBJQ== X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Proxy: X-ME-Sender: Received: from xps.monjalon.net (184.203.134.77.rev.sfr.net [77.134.203.184]) by mail.messagingengine.com (Postfix) with ESMTPA id EC741E42B0; Thu, 31 May 2018 17:11:29 -0400 (EDT) From: Thomas Monjalon To: dev@dpdk.org Cc: john.mcnamara@intel.com, marko.kovacevic@intel.com Date: Thu, 31 May 2018 23:11:23 +0200 Message-Id: <20180531211123.25758-1-thomas@monjalon.net> X-Mailer: git-send-email 2.17.1 Subject: [dpdk-dev] [PATCH] doc: add template release notes for 18.08 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 31 May 2018 21:11:31 -0000 Add template release notes for DPDK 18.08 with inline comments and explanations of the various sections. Signed-off-by: Thomas Monjalon --- doc/guides/rel_notes/index.rst | 1 + doc/guides/rel_notes/release_18_08.rst | 192 +++++++++++++++++++++++++ 2 files changed, 193 insertions(+) create mode 100644 doc/guides/rel_notes/release_18_08.rst diff --git a/doc/guides/rel_notes/index.rst b/doc/guides/rel_notes/index.rst index eb82a0e06..d125342c3 100644 --- a/doc/guides/rel_notes/index.rst +++ b/doc/guides/rel_notes/index.rst @@ -9,6 +9,7 @@ Release Notes :numbered: rel_description + release_18_08 release_18_05 release_18_02 release_17_11 diff --git a/doc/guides/rel_notes/release_18_08.rst b/doc/guides/rel_notes/release_18_08.rst new file mode 100644 index 000000000..5bc23c537 --- /dev/null +++ b/doc/guides/rel_notes/release_18_08.rst @@ -0,0 +1,192 @@ +DPDK Release 18.08 +================== + +.. **Read this first.** + + The text in the sections below explains how to update the release notes. + + Use proper spelling, capitalization and punctuation in all sections. + + Variable and config names should be quoted as fixed width text: + ``LIKE_THIS``. + + Build the docs and view the output file to ensure the changes are correct:: + + make doc-guides-html + + xdg-open build/doc/html/guides/rel_notes/release_18_08.html + + +New Features +------------ + +.. This section should contain new features added in this release. + Sample format: + + * **Add a title in the past tense with a full stop.** + + Add a short 1-2 sentence description in the past tense. + The description should be enough to allow someone scanning + the release notes to understand the new feature. + + If the feature adds a lot of sub-features you can use a bullet list + like this: + + * Added feature foo to do something. + * Enhanced feature bar to do something else. + + Refer to the previous release notes for examples. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +API Changes +----------- + +.. This section should contain API changes. Sample format: + + * Add a short 1-2 sentence description of the API change. + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +ABI Changes +----------- + +.. This section should contain ABI changes. Sample format: + + * Add a short 1-2 sentence description of the ABI change + that was announced in the previous releases and made in this release. + Use fixed width quotes for ``function_names`` or ``struct_names``. + Use the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +Removed Items +------------- + +.. This section should contain removed items in this release. Sample format: + + * Add a short 1-2 sentence description of the removed item + in the past tense. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +Shared Library Versions +----------------------- + +.. Update any library version updated in this release + and prepend with a ``+`` sign, like this: + + librte_acl.so.2 + + librte_cfgfile.so.2 + librte_cmdline.so.2 + + This section is a comment. Do not overwrite or remove it. + ========================================================= + +The libraries prepended with a plus sign were incremented in this version. + +.. code-block:: diff + + librte_acl.so.2 + librte_bbdev.so.1 + librte_bitratestats.so.2 + librte_bpf.so.1 + librte_bus_dpaa.so.1 + librte_bus_fslmc.so.1 + librte_bus_pci.so.1 + librte_bus_vdev.so.1 + librte_cfgfile.so.2 + librte_cmdline.so.2 + librte_common_octeontx.so.1 + librte_compressdev.so.1 + librte_cryptodev.so.4 + librte_distributor.so.1 + librte_eal.so.7 + librte_ethdev.so.9 + librte_eventdev.so.4 + librte_flow_classify.so.1 + librte_gro.so.1 + librte_gso.so.1 + librte_hash.so.2 + librte_ip_frag.so.1 + librte_jobstats.so.1 + librte_kni.so.2 + librte_kvargs.so.1 + librte_latencystats.so.1 + librte_lpm.so.2 + librte_mbuf.so.4 + librte_mempool.so.4 + librte_meter.so.2 + librte_metrics.so.1 + librte_net.so.1 + librte_pci.so.1 + librte_pdump.so.2 + librte_pipeline.so.3 + librte_pmd_bnxt.so.2 + librte_pmd_bond.so.2 + librte_pmd_i40e.so.2 + librte_pmd_ixgbe.so.2 + librte_pmd_dpaa2_cmdif.so.1 + librte_pmd_dpaa2_qdma.so.1 + librte_pmd_ring.so.2 + librte_pmd_softnic.so.1 + librte_pmd_vhost.so.2 + librte_port.so.3 + librte_power.so.1 + librte_rawdev.so.1 + librte_reorder.so.1 + librte_ring.so.2 + librte_sched.so.1 + librte_security.so.1 + librte_table.so.3 + librte_timer.so.1 + librte_vhost.so.3 + + +Known Issues +------------ + +.. This section should contain new known issues in this release. Sample format: + + * **Add title in present tense with full stop.** + + Add a short 1-2 sentence description of the known issue + in the present tense. Add information on any known workarounds. + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= + + +Tested Platforms +---------------- + +.. This section should contain a list of platforms that were tested + with this release. + + The format is: + + * platform with combinations + + * List of CPU + * List of OS + * List of devices + * Other relevant details... + + This section is a comment. Do not overwrite or remove it. + Also, make sure to start the actual text at the margin. + ========================================================= -- 2.17.1