> -----Original Message-----
> From: Ray Kinsella <[email protected]>
> Sent: Friday, October 25, 2019 5:29 PM
> To: [email protected]
> Cc: [email protected]; [email protected]; [email protected];
> Richardson, Bruce <[email protected]>; Yigit, Ferruh
> <[email protected]>; Ananyev, Konstantin
> <[email protected]>; [email protected];
> [email protected]; [email protected];
> [email protected]; Mcnamara, John <[email protected]>;
> Kovacevic, Marko <[email protected]>; [email protected];
> [email protected]; [email protected]
> 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 <[email protected]>
> ---
> 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
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
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
John
