From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: <erik.g.carrillo@intel.com> Received: from mga18.intel.com (mga18.intel.com [134.134.136.126]) by dpdk.org (Postfix) with ESMTP id 4F9148E01 for <dev@dpdk.org>; Fri, 16 Feb 2018 23:54:52 +0100 (CET) X-Amp-Result: SKIPPED(no attachment in message) X-Amp-File-Uploaded: False Received: from orsmga008.jf.intel.com ([10.7.209.65]) by orsmga106.jf.intel.com with ESMTP/TLS/DHE-RSA-AES256-GCM-SHA384; 16 Feb 2018 14:54:49 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.46,520,1511856000"; d="scan'208";a="18773276" Received: from fmsmsx105.amr.corp.intel.com ([10.18.124.203]) by orsmga008.jf.intel.com with ESMTP; 16 Feb 2018 14:54:49 -0800 Received: from fmsmsx157.amr.corp.intel.com (10.18.116.73) by FMSMSX105.amr.corp.intel.com (10.18.124.203) with Microsoft SMTP Server (TLS) id 14.3.319.2; Fri, 16 Feb 2018 14:54:49 -0800 Received: from fmsmsx115.amr.corp.intel.com ([169.254.4.14]) by FMSMSX157.amr.corp.intel.com ([169.254.14.60]) with mapi id 14.03.0319.002; Fri, 16 Feb 2018 14:54:48 -0800 From: "Carrillo, Erik G" <erik.g.carrillo@intel.com> To: "Mcnamara, John" <john.mcnamara@intel.com>, "dev@dpdk.org" <dev@dpdk.org> CC: "Mcnamara, John" <john.mcnamara@intel.com> Thread-Topic: [dpdk-dev] [PATCH v1] doc: add template release notes for 18.05 Thread-Index: AQHTpl2G6MsVpWqqY0GNXN5C3KI5U6OnpTbA Date: Fri, 16 Feb 2018 22:54:48 +0000 Message-ID: <BE54F058557D9A4FAC1D84E2FC6D87570EDC2707@fmsmsx115.amr.corp.intel.com> References: <1518699848-336-1-git-send-email-john.mcnamara@intel.com> In-Reply-To: <1518699848-336-1-git-send-email-john.mcnamara@intel.com> Accept-Language: en-US Content-Language: en-US X-MS-Has-Attach: X-MS-TNEF-Correlator: dlp-product: dlpe-windows dlp-version: 11.0.0.116 dlp-reaction: no-action x-titus-metadata-40: eyJDYXRlZ29yeUxhYmVscyI6IiIsIk1ldGFkYXRhIjp7Im5zIjoiaHR0cDpcL1wvd3d3LnRpdHVzLmNvbVwvbnNcL0ludGVsMyIsImlkIjoiZjcxY2IzN2QtMzU0Mi00NmQyLWFmNmQtNGM1NTc5MjU4MmY0IiwicHJvcHMiOlt7Im4iOiJDVFBDbGFzc2lmaWNhdGlvbiIsInZhbHMiOlt7InZhbHVlIjoiQ1RQX05UIn1dfV19LCJTdWJqZWN0TGFiZWxzIjpbXSwiVE1DVmVyc2lvbiI6IjE3LjIuNS4xOCIsIlRydXN0ZWRMYWJlbEhhc2giOiJhVnlkNWFPVkNMazhRbUxYOUtBMEtBcXY3cmFjZlVhNkd2VmZqNFQrZ0V5VTFiK0phVnphZHR5Qm13eGxjTXFJIn0= x-ctpclassification: CTP_NT x-originating-ip: [10.1.200.108] Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 Subject: Re: [dpdk-dev] [PATCH v1] doc: add template release notes for 18.05 X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: DPDK patches and discussions <dev.dpdk.org> List-Unsubscribe: <https://dpdk.org/ml/options/dev>, <mailto:dev-request@dpdk.org?subject=unsubscribe> List-Archive: <http://dpdk.org/ml/archives/dev/> List-Post: <mailto:dev@dpdk.org> List-Help: <mailto:dev-request@dpdk.org?subject=help> List-Subscribe: <https://dpdk.org/ml/listinfo/dev>, <mailto:dev-request@dpdk.org?subject=subscribe> X-List-Received-Date: Fri, 16 Feb 2018 22:54:52 -0000 > -----Original Message----- > From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of John McNamara > Sent: Thursday, February 15, 2018 7:04 AM > To: dev@dpdk.org > Cc: Mcnamara, John <john.mcnamara@intel.com> > Subject: [dpdk-dev] [PATCH v1] doc: add template release notes for 18.05 >=20 > Add template release notes for DPDK 18.05 with inline comments and > explanations of the various sections. >=20 > Signed-off-by: John McNamara <john.mcnamara@intel.com> > --- > doc/guides/rel_notes/release_18_05.rst | 187 > +++++++++++++++++++++++++++++++++ > 1 file changed, 187 insertions(+) > create mode 100644 doc/guides/rel_notes/release_18_05.rst >=20 > diff --git a/doc/guides/rel_notes/release_18_05.rst > b/doc/guides/rel_notes/release_18_05.rst > new file mode 100644 > index 0000000..85f4dc5 > --- /dev/null > +++ b/doc/guides/rel_notes/release_18_05.rst > @@ -0,0 +1,187 @@ > +DPDK Release 18.05 > +=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D > + > +.. **Read this first.** > + > + The text in the sections below explains how to update the release not= es. > + > + 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 cor= rect:: > + > + make doc-guides-html > + > + xdg-open build/doc/html/guides/rel_notes/release_18_05.html > + > + > +New Features > +------------ > + > +.. This section should contain new features added in this release. Sampl= e > + format: > + > + * **Add a title in the past tense with a full stop.** > + > + Add a short 1-2 sentence description in the past tense. The descrip= tion > + 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. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +API Changes > +----------- > + > +.. This section should contain API changes. Sample format: > + > + * Add a short 1-2 sentence description of the API change. Use fixed w= idth > + quotes for ``rte_function_names`` or ``rte_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. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +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 ``rte_function_names`` or ``rte_struct_names``. Use the past te= nse. > + > + This section is a comment. Do not overwrite or remove it. > + Also, make sure to start the actual text at the margin. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +Removed Items > +------------- > + > +.. This section should contain removed items in this release. Sample for= mat: > + > + * Add a short 1-2 sentence description of the removed item in the pas= t > + tense. > + > + This section is a comment. Do not overwrite or remove it. > + Also, make sure to start the actual text at the margin. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +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 pres= ent > + 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. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +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. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > + > + > +The libraries prepended with a plus sign were incremented in this versio= n. > + > +.. code-block:: diff > + > + librte_acl.so.2 > + librte_bbdev.so.1 > + librte_bitratestats.so.2 > + 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_cryptodev.so.4 > + librte_distributor.so.1 > + librte_eal.so.6 > + librte_ethdev.so.8 > + librte_eventdev.so.3 > + 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.3 > + librte_mempool.so.3 > + librte_meter.so.1 > + 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_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.1 > + librte_sched.so.1 > + librte_security.so.1 > + librte_table.so.3 > + librte_timer.so.1 > + librte_vhost.so.3 > + > + > +Tested Platforms > +---------------- > + > +.. This section should contain a list of platforms that were tested with= this > + release. > + > + The format is: > + > + * <vendor> platform with <vendor> <type of devices> 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. > + > =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D > -- > 2.7.5 Acked-by: Erik Gabriel Carrillo <erik.g.carrillo@intel.com>