From: Ray Kinsella <mdr@ashroe.eu>
To: "Mcnamara, John" <john.mcnamara@intel.com>,
"dev@dpdk.org" <dev@dpdk.org>
Cc: "thomas@monjalon.net" <thomas@monjalon.net>,
"stephen@networkplumber.org" <stephen@networkplumber.org>,
"Richardson, Bruce" <bruce.richardson@intel.com>,
"Yigit, Ferruh" <ferruh.yigit@intel.com>,
"Ananyev, Konstantin" <konstantin.ananyev@intel.com>,
"jerinj@marvell.com" <jerinj@marvell.com>,
"olivier.matz@6wind.com" <olivier.matz@6wind.com>,
"nhorman@tuxdriver.com" <nhorman@tuxdriver.com>,
"maxime.coquelin@redhat.com" <maxime.coquelin@redhat.com>,
"Kovacevic, Marko" <marko.kovacevic@intel.com>,
"hemant.agrawal@nxp.com" <hemant.agrawal@nxp.com>,
"ktraynor@redhat.com" <ktraynor@redhat.com>,
"aconole@redhat.com" <aconole@redhat.com>
Subject: Re: [dpdk-dev] [PATCH v7 2/4] doc: changes to abi policy introducing major abi versions
Date: Tue, 5 Nov 2019 15:11:45 +0000 [thread overview]
Message-ID: <f27b710d-d2af-77d9-c6ae-9f7b9eb42b40@ashroe.eu> (raw)
In-Reply-To: <B27915DBBA3421428155699D51E4CFE24BDA50F9@IRSMSX103.ger.corp.intel.com>
On 31/10/2019 15:06, Mcnamara, John wrote:
>
>
>> -----Original Message-----
>> From: Ray Kinsella <mdr@ashroe.eu>
>> Sent: Friday, October 25, 2019 5:29 PM
>> To: dev@dpdk.org
>> Cc: mdr@ashroe.eu; thomas@monjalon.net; stephen@networkplumber.org;
>> Richardson, Bruce <bruce.richardson@intel.com>; Yigit, Ferruh
>> <ferruh.yigit@intel.com>; Ananyev, Konstantin
>> <konstantin.ananyev@intel.com>; jerinj@marvell.com;
>> olivier.matz@6wind.com; nhorman@tuxdriver.com;
>> maxime.coquelin@redhat.com; Mcnamara, John <john.mcnamara@intel.com>;
>> Kovacevic, Marko <marko.kovacevic@intel.com>; hemant.agrawal@nxp.com;
>> ktraynor@redhat.com; aconole@redhat.com
>> Subject: [PATCH v7 2/4] doc: changes to abi policy introducing major abi
>> versions
>>
>> This policy change introduces major ABI versions, these are
>> declared every year, typically aligned with the LTS release
>> and are supported by subsequent releases in the following year.
>> This change is intended to improve ABI stabilty for those projects
>> consuming DPDK.
>>
>> Signed-off-by: Ray Kinsella <mdr@ashroe.eu>
>> ---
>> doc/guides/contributing/abi_policy.rst | 321 ++++--
>> .../contributing/img/abi_stability_policy.svg | 1059
>
>
> There are build warnings after this patch. I know they are fixed in patch 3 but there shouldn't be any build warnings in each patch of the patchset.
>
> $ make doc-guides-html
> sphinx processing guides-html...
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:18:
> WARNING: undefined label: what_is_soname (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:22:
> WARNING: undefined label: abi_versioning (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:63:
> WARNING: undefined label: what_is_soname (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:73:
> WARNING: undefined label: major_abi_versions (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:145:
> WARNING: undefined label: abi_versioning (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:221:
> WARNING: undefined label: abi_versioning (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/abi_policy.rst:318:
> WARNING: undefined label: abi_versioning (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/contributing/patches.rst:159:
> WARNING: unknown document: /contributing/versioning
> /work/dpdk_docs/doc/guides/contributing/stable.rst:56:
> WARNING: undefined label: abi_policy (if the link has no caption the label must precede a section header)
> /work/dpdk_docs/doc/guides/rel_notes/deprecation.rst:7:
> WARNING: unknown document: /contributing/versioning
ACK resolved in v8
>
>
> The syntax of the following image caption is wrong:
>
> .. _figure_what_is_an_abi:
>
> .. figure:: img/what_is_an_abi.*
>
> *Figure 1. Illustration of DPDK API and ABI .*
>
> It should be indented and shouldn't have a figure number (that is added automatically) or bolding. Like this:
>
> .. _figure_what_is_an_abi:
>
> .. figure:: img/what_is_an_abi.*
>
> Illustration of DPDK API and ABI.
>
> See the following for details:
> http://doc.dpdk.org/guides/contributing/documentation.html#images
ACK resolved in v8 (for both figures)
>
> The is a stray backtick here:
>
>
> +changes must follow the `same process :ref:`described above <abi_changes>` as non-breaking
>
> It should be:
>
> +changes must follow the same process :ref:`described above <abi_changes>` as non-breaking
ACK resolved in v8
>
> John
>
next prev parent reply other threads:[~2019-11-05 15:11 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-10-25 16:28 [dpdk-dev] [PATCH v7 0/4] " Ray Kinsella
2019-10-25 16:28 ` [dpdk-dev] [PATCH v7 1/4] doc: separate versioning.rst into version and policy Ray Kinsella
2019-10-31 15:02 ` Mcnamara, John
2019-11-05 15:11 ` Ray Kinsella
2019-10-25 16:28 ` [dpdk-dev] [PATCH v7 2/4] doc: changes to abi policy introducing major abi versions Ray Kinsella
2019-10-31 15:06 ` Mcnamara, John
2019-11-05 15:11 ` Ray Kinsella [this message]
2019-10-25 16:28 ` [dpdk-dev] [PATCH v7 3/4] doc: updates to versioning guide for " Ray Kinsella
2019-10-31 15:07 ` Mcnamara, John
2019-10-25 16:28 ` [dpdk-dev] [PATCH v7 4/4] doc: add maintainer for abi policy Ray Kinsella
2019-10-31 15:07 ` Mcnamara, John
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=f27b710d-d2af-77d9-c6ae-9f7b9eb42b40@ashroe.eu \
--to=mdr@ashroe.eu \
--cc=aconole@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@intel.com \
--cc=hemant.agrawal@nxp.com \
--cc=jerinj@marvell.com \
--cc=john.mcnamara@intel.com \
--cc=konstantin.ananyev@intel.com \
--cc=ktraynor@redhat.com \
--cc=marko.kovacevic@intel.com \
--cc=maxime.coquelin@redhat.com \
--cc=nhorman@tuxdriver.com \
--cc=olivier.matz@6wind.com \
--cc=stephen@networkplumber.org \
--cc=thomas@monjalon.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).