[v3] doc: add meson build to contributing guide

Message ID 20181030141847.23861-1-vipin.varghese@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Thomas Monjalon
Headers
Series [v3] doc: add meson build to contributing guide |

Checks

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

Commit Message

Varghese, Vipin Oct. 30, 2018, 2:18 p.m. UTC
  Patches has to be validated for meson builds. Updating documentation
for meson build steps in Checking Compilation category.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---

V3:
removed extra character - Vipin Varghese

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

Comments

Kovacevic, Marko Nov. 14, 2018, 2:30 p.m. UTC | #1
> Patches has to be validated for meson builds. Updating documentation for
> meson build steps in Checking Compilation category.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
> 
> V3:
> removed extra character - Vipin Varghese
> 
> V2:
> updated the meson build options - Bruce Richardson
> ---
>  doc/guides/contributing/patches.rst | 6 ++++++
>  1 file changed, 6 insertions(+)
> 
> diff --git a/doc/guides/contributing/patches.rst
> b/doc/guides/contributing/patches.rst
> index a3d788024..adcadb817 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -468,6 +468,12 @@ The recommended configurations and options to
> test compilation prior to submitti
>     export DPDK_DEP_PCAP=y
>     export DPDK_DEP_SSL=y
> 
> +Compliation of patches has to be tested using meson::
> +
> +    ./devtools/test-meson-builds.sh
> +
> +This will test for shared and static builds. If gcc arm cross compiler
> +is installed, cross build is tested too.
> 
>  Sending Patches
>  ---------------

Ran the script all runs fine 

Tested-by: Marko Kovacevic <marko.kovacevic@intel.com>
Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
  
Thomas Monjalon Nov. 24, 2018, 6:57 p.m. UTC | #2
14/11/2018 15:30, Kovacevic, Marko:
> > Patches has to be validated for meson builds. Updating documentation for
> > meson build steps in Checking Compilation category.
> > 
> > Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> > --- a/doc/guides/contributing/patches.rst
> > +++ b/doc/guides/contributing/patches.rst
> > @@ -468,6 +468,12 @@ The recommended configurations and options to
> > test compilation prior to submitti
> >     export DPDK_DEP_PCAP=y
> >     export DPDK_DEP_SSL=y
> > 
> > +Compliation of patches has to be tested using meson::
> > +
> > +    ./devtools/test-meson-builds.sh
> > +
> > +This will test for shared and static builds. If gcc arm cross compiler
> > +is installed, cross build is tested too.
> > 
> >  Sending Patches
> >  ---------------
> 
> Ran the script all runs fine 
> 
> Tested-by: Marko Kovacevic <marko.kovacevic@intel.com>
> Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>

Yes we must add such explanation, but it can be improved.

We should make clear that meson must be tested in addition of make.

We could be more explicit about cross-compilation, saying on x86 host,
both x86 and Arm can be compiled thanks to the cross compilers.

More details:
- s/Compliation/Compilation/
- the double blank line is removed before next header
  
Varghese, Vipin Jan. 10, 2019, 4:37 p.m. UTC | #3
HI Thomas

snipped
> > >
> > > +Compliation of patches has to be tested using meson::
> > > +
> > > +    ./devtools/test-meson-builds.sh
> > > +
> > > +This will test for shared and static builds. If gcc arm cross
> > > +compiler is installed, cross build is tested too.
> > >
> > >  Sending Patches
> > >  ---------------
> >
> > Ran the script all runs fine
> >
> > Tested-by: Marko Kovacevic <marko.kovacevic@intel.com>
> > Acked-by: Marko Kovacevic <marko.kovacevic@intel.com>
> 
> Yes we must add such explanation, but it can be improved.
> 
> We should make clear that meson must be tested in addition of make.

In Patch ' https://patches.dpdk.org/patch/47562/´as per suggestion Bruce, we have given emphasis on  ' Compliation of patches has to be tested using meson'. In my opinion, this is bare minimum one liner, which is required to be executed for any patch before sending.
 
> 
> We could be more explicit about cross-compilation, saying on x86 host, both
> x86 and Arm can be compiled thanks to the cross compilers.
> 
I believe this should be covered about compilation section and features.

> More details:
> - s/Compliation/Compilation/
> - the double blank line is removed before next header
> 
>
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a3d788024..adcadb817 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -468,6 +468,12 @@  The recommended configurations and options to test compilation prior to submitti
    export DPDK_DEP_PCAP=y
    export DPDK_DEP_SSL=y
 
+Compliation of patches has to be tested using meson::
+
+    ./devtools/test-meson-builds.sh
+
+This will test for shared and static builds. If gcc arm cross compiler is
+installed, cross build is tested too.
 
 Sending Patches
 ---------------