[v5] doc/patches: add meson build to contributing guide

Message ID 20190129101036.35002-1-vipin.varghese@intel.com
State Changes Requested
Delegated to: Thomas Monjalon
Headers show
Series
  • [v5] doc/patches: add meson build to contributing guide
Related show

Checks

Context Check Description
ci/Intel-compilation success Compilation OK
ci/checkpatch success coding style OK

Commit Message

Varghese, Vipin Jan. 29, 2019, 10:10 a.m.
Patches has to be validated for meson devtool script for
code and document changes. Updating documentation for meson
build steps in checking Compilation category.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
Tested-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
---

V5:
 create sub section to Compilation - Thomas Monjalon
 remove Linux and BSD references - Thomas Monjalon
 reword tool chain to toolchain - Thomas Monjalon

V4:
 spelling correction for Compilation - Thomas Monjalon
 restored double space for new header - Thomas Monjalon
 reword the meson compilation content - Vipin Varghese
 added 'tested' and 'acked' from - Marko Kovacevic

V3:
 removed extra character - Vipin Varghese

V2:
 updated the meson build options - Bruce Richardson
---
 doc/guides/contributing/patches.rst | 8 ++++++++
 1 file changed, 8 insertions(+)

Comments

Thomas Monjalon Feb. 12, 2019, 9:36 a.m. | #1
29/01/2019 11:10, Vipin Varghese:
> +Meson system
> +~~~~~~~~~~~~

What do you think about adding "Makefile system" title for previous section?
We could also add an introduction explaining that both systems must be tested.

> +
> +Compilation of patches is to be tested with ``devtools/test-meson-builds.sh`` script in ``devtools``

A dot is missing. You may remove "in ``devtools``" as it is already in the path.

> +
> +The script internally checks for dependencies, then builds for several
> +combinations of compilation configuration.
> +
Varghese, Vipin Feb. 13, 2019, 5:38 a.m. | #2
Sure, I will share v6 with the changes

> -----Original Message-----
> From: Thomas Monjalon <thomas@monjalon.net>
> Sent: Tuesday, February 12, 2019 3:06 PM
> To: Varghese, Vipin <vipin.varghese@intel.com>
> Cc: dev@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>; Kovacevic,
> Marko <marko.kovacevic@intel.com>; Yigit, Ferruh <ferruh.yigit@intel.com>;
> Padubidri, Sanjay A <sanjay.padubidri@intel.com>; Patel, Amol
> <amol.patel@intel.com>; Richardson, Bruce <bruce.richardson@intel.com>
> Subject: Re: [dpdk-dev] [PATCH v5] doc/patches: add meson build to contributing
> guide
> 
> 29/01/2019 11:10, Vipin Varghese:
> > +Meson system
> > +~~~~~~~~~~~~
> 
> What do you think about adding "Makefile system" title for previous section?
> We could also add an introduction explaining that both systems must be tested.
> 
> > +
> > +Compilation of patches is to be tested with
> > +``devtools/test-meson-builds.sh`` script in ``devtools``
> 
> A dot is missing. You may remove "in ``devtools``" as it is already in the path.
> 
> > +
> > +The script internally checks for dependencies, then builds for
> > +several combinations of compilation configuration.
> > +
> 
>

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a64bb0368..4b6b00b7a 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -473,6 +473,14 @@  The recommended configurations and options to test compilation prior to submitti
    export DPDK_DEP_PCAP=y
    export DPDK_DEP_SSL=y
 
+Meson system
+~~~~~~~~~~~~
+
+Compilation of patches is to be tested with ``devtools/test-meson-builds.sh`` script in ``devtools``
+
+The script internally checks for dependencies, then builds for several
+combinations of compilation configuration.
+
 
 Sending Patches
 ---------------