[v1] doc: add meson build to contributing guide

Message ID 20181030045633.18859-1-vipin.varghese@intel.com (mailing list archive)
State Changes Requested, archived
Delegated to: Thomas Monjalon
Headers
Series [v1] 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, 4:56 a.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>
---
 doc/guides/contributing/patches.rst | 9 +++++++++
 1 file changed, 9 insertions(+)
  

Comments

Bruce Richardson Oct. 30, 2018, 10:54 a.m. UTC | #1
On Tue, Oct 30, 2018 at 10:26:33AM +0530, Vipin Varghese wrote:
> 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>
> ---
>  doc/guides/contributing/patches.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
> index a3d788024..494037778 100644
> --- a/doc/guides/contributing/patches.rst
> +++ b/doc/guides/contributing/patches.rst
> @@ -468,6 +468,15 @@ 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'
> +
> +The default build target is for shared library. Build can be modified for
> +static and cross build by
> +
> + * static by ``--default-library=static``.
> + * arm cross build use ``--cross-file=<path>`` to override default path.
>  

If you are telling people to use test-meson-builds.sh, you don't need these
instructions, since that script builds using both static and shared
settings. The regular builds actually use "static" by default, not
"shared", but note that that only affects app linkage - both libraries are
always built. 

The test-meson-builds.sh script builds most of it's test cases using
shared, simply for reasons of saving space on disk. Doing that number of
static builds can use a *lot* [1.5G or more] of disk space. However,
outside of using the script, DPDK builds default to using "static".

/Bruce

>  Sending Patches
>  ---------------
> -- 
> 2.17.1
>
  

Patch

diff --git a/doc/guides/contributing/patches.rst b/doc/guides/contributing/patches.rst
index a3d788024..494037778 100644
--- a/doc/guides/contributing/patches.rst
+++ b/doc/guides/contributing/patches.rst
@@ -468,6 +468,15 @@  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'
+
+The default build target is for shared library. Build can be modified for
+static and cross build by
+
+ * static by ``--default-library=static``.
+ * arm cross build use ``--cross-file=<path>`` to override default path.
 
 Sending Patches
 ---------------