[dpdk-dev] [PATCH v7 1/4] doc: separate versioning.rst into version and policy

Mcnamara, John john.mcnamara at intel.com
Thu Oct 31 16:02:28 CET 2019



> -----Original Message-----
> From: Ray Kinsella <mdr at ashroe.eu>
> Sent: Friday, October 25, 2019 5:29 PM
> To: dev at dpdk.org
> Cc: mdr at ashroe.eu; thomas at monjalon.net; stephen at networkplumber.org;
> Richardson, Bruce <bruce.richardson at intel.com>; Yigit, Ferruh
> <ferruh.yigit at intel.com>; Ananyev, Konstantin
> <konstantin.ananyev at intel.com>; jerinj at marvell.com;
> olivier.matz at 6wind.com; nhorman at tuxdriver.com;
> maxime.coquelin at redhat.com; Mcnamara, John <john.mcnamara at intel.com>;
> Kovacevic, Marko <marko.kovacevic at intel.com>; hemant.agrawal at nxp.com;
> ktraynor at redhat.com; aconole at redhat.com
> Subject: [PATCH v7 1/4] doc: separate versioning.rst into version and
> policy
> 
> Separate versioning.rst into abi versioning and abi policy guidance, in
> preparation for adding more detail to the abi policy.
> 
> Signed-off-by: Ray Kinsella <mdr at ashroe.eu>
> ---
>  doc/guides/contributing/abi_policy.rst     | 167 ++++++++
>  doc/guides/contributing/abi_versioning.rst | 427 +++++++++++++++++++++
>  doc/guides/contributing/index.rst          |   3 +-
>  doc/guides/contributing/versioning.rst     | 591 -----------------------


I think the it would be better to "git mv" versioning.rst to abi_versioning.rst first to maintain the history and then extract out the policy part.

Also, there is a build warning after this patch:


    $ make doc-guides-html
    sphinx processing guides-html...
    /work/dpdk_docs/doc/guides/contributing/patches.rst:159: 
    WARNING: unknown document: /contributing/versioning
    /work/dpdk_docs/doc/guides/rel_notes/deprecation.rst:7: 
    WARNING: unknown document: /contributing/versioning

John


More information about the dev mailing list