From: Jananee Parthasarathy <jananeex.m.parthasarathy@intel.com>
To: dev@dpdk.org
Cc: reshma.pattan@intel.com, john.mcnamara@intel.com,
marko.kovacevic@intel.com, bruce.richardson@intel.com,
jananeex.m.parthasarathy@intel.com,
Hari Kumar Vemula <hari.kumarx.vemula@intel.com>
Subject: [dpdk-dev] [PATCH v8] doc: add meson ut info in prog guide
Date: Mon, 12 Aug 2019 13:40:25 +0100 [thread overview]
Message-ID: <1565613625-6079-1-git-send-email-jananeex.m.parthasarathy@intel.com> (raw)
In-Reply-To: <1565186178-15950-1-git-send-email-agalyax.babu.radhakrishnan@intel.com>
From: Hari Kumar Vemula <hari.kumarx.vemula@intel.com>
Add a programmer's guide section for meson ut
Signed-off-by: Hari Kumar Vemula <hari.kumarx.vemula@intel.com>
Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Acked-by: Michael Santana <msantana@redhat.com>
---
v8: Addressed v7 patch comments
v7: Updated v6 patch comments
v6: Updated comments
v5: Modified
v4: Typos corrected
v3: Modified
v2: Removed enhancement details
---
.../prog_guide/build-sdk-meson.rst} | 7 +-
doc/guides/prog_guide/index.rst | 2 +
doc/guides/prog_guide/meson_ut.rst | 104 ++++++++++++++++++
3 files changed, 110 insertions(+), 3 deletions(-)
rename doc/{build-sdk-meson.txt => guides/prog_guide/build-sdk-meson.rst} (97%)
create mode 100644 doc/guides/prog_guide/meson_ut.rst
diff --git a/doc/build-sdk-meson.txt b/doc/guides/prog_guide/build-sdk-meson.rst
similarity index 97%
rename from doc/build-sdk-meson.txt
rename to doc/guides/prog_guide/build-sdk-meson.rst
index fc7fe37b5..34c363694 100644
--- a/doc/build-sdk-meson.txt
+++ b/doc/guides/prog_guide/build-sdk-meson.rst
@@ -1,5 +1,5 @@
-INSTALLING DPDK USING THE MESON BUILD SYSTEM
----------------------------------------------
+Installing DPDK Using the meson build system
+============================================
Summary
--------
@@ -162,7 +162,8 @@ command::
For example if the target machine is arm64 we can use the following
command::
- meson arm-build --cross-file config/arm/arm64_armv8_linux_gcc
+
+ meson arm-build --cross-file config/arm/arm64_armv8_linux_gcc
where config/arm/arm64_armv8_linux_gcc contains settings for the compilers
and other build tools to be used, as well as characteristics of the target
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 692409af8..0bab96c58 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -60,6 +60,8 @@ Programmer's Guide
source_org
dev_kit_build_system
dev_kit_root_make_help
+ build-sdk-meson
+ meson_ut
extend_dpdk
build_app
ext_app_lib_make_help
diff --git a/doc/guides/prog_guide/meson_ut.rst b/doc/guides/prog_guide/meson_ut.rst
new file mode 100644
index 000000000..45193ddde
--- /dev/null
+++ b/doc/guides/prog_guide/meson_ut.rst
@@ -0,0 +1,104 @@
+.. SPDX-License-Identifier: BSD-3-Clause
+ Copyright(c) 2018-2019 Intel Corporation.
+
+Running DPDK Unit Tests with Meson
+==================================
+
+This section describes how to run test cases with the DPDK meson build system.
+
+Steps to build and install DPDK using meson can be referred
+in :doc:`build-sdk-meson`
+
+Grouping of test cases
+----------------------
+
+Test cases have been classified into four different groups.
+
+* Fast tests.
+* Performance tests.
+* Driver tests.
+* Tests which produce lists of objects as output, and therefore that need
+ manual checking.
+
+These tests can be run using the argument to ``meson test`` as
+``--suite project_name:label``.
+
+For example::
+
+ $ meson test -C <build path> --suite DPDK:fast-tests
+
+If the ``<build path>`` is current working directory,
+the ``-C <build path>`` option can be skipped as below::
+
+ $ meson test --suite DPDK:fast-tests
+
+The project name is optional so the following is equivalent to the previous
+command::
+
+ $ meson test --suite fast-tests
+
+The meson command to list all available tests::
+
+ $ meson test --list
+
+Test cases are run serially by default for better stability.
+
+Arguments of ``test()`` that can be provided in meson.build are as below:
+
+* ``is_parallel`` is used to run test case either in parallel or non-parallel mode.
+* ``timeout`` is used to specify the timeout of test case.
+* ``args`` is used to specify test specific parameters.
+* ``env`` is used to specify test specific environment parameters.
+
+
+Dealing with skipped test cases
+-------------------------------
+
+Some unit test cases have a dependency on external libraries, driver modules
+or config flags, without which the test cases cannot be run. Such test cases
+will be reported as skipped if they cannot run. To enable those test cases,
+the user should ensure the required dependencies are met. Below are a few
+possible causes why tests may be skipped and how they may be resolved:
+
+#. Optional external libraries are not found.
+#. Config flags for the dependent library are not enabled.
+#. Dependent driver modules are not installed on the system.
+#. Not enough processing cores. Some tests are skipped on machines with 2 or 4 cores.
+
+To help find missing libraries, the user can specify additional search paths
+for those libraries as below:
+
+* Single path::
+
+ $ export LIBRARY_PATH=path
+
+* Multiple paths::
+
+ $ export LIBRARY_PATH=path1:path2:path3
+
+Some functionality may be disabled due to library headers being missed as part
+of the build. To specify an additional search path for headers at
+configuration time, use one of the commands below:
+
+* Single path::
+
+ $ CFLAGS=-I/path meson build
+
+* Multiple paths::
+
+ $ CFLAGS=`-I/path1 -I/path2 meson build`
+
+Below are some examples that show how to export libraries and their header
+paths.
+
+To specify a single library at a time::
+
+ $ export LIBRARY_PATH=/root/wireless_libs/zuc/
+ $ CFLAGS=-I/root/wireless_libs/zuc/include meson build
+
+To specify multiple libraries at a time::
+
+ $ export LIBRARY_PATH=/path/zuc/:/path/libsso_kasumi/build/
+ $ CFLAGS=-I/path/zuc/include \
+ -I/path/libsso_kasumi/include \
+ meson build
--
2.17.2
next prev parent reply other threads:[~2019-08-12 12:41 UTC|newest]
Thread overview: 49+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <yes>
2018-12-12 11:35 ` [dpdk-dev] [PATCH] doc: add meson ut enhancements " Hari Kumar Vemula
2019-01-20 12:04 ` Thomas Monjalon
2019-01-23 6:37 ` [dpdk-dev] [PATCH v2] doc: add meson ut info " Hari Kumar Vemula
2019-01-23 10:53 ` Bruce Richardson
2019-01-24 13:41 ` [dpdk-dev] [PATCH v3] " Hari Kumar Vemula
2019-01-24 14:15 ` Richardson, Bruce
2019-01-25 6:20 ` [dpdk-dev] [PATCH v4] " Hari Kumar Vemula
2019-01-31 14:49 ` Bruce Richardson
2019-02-02 10:28 ` [dpdk-dev] [PATCH v5] " Hari Kumar Vemula
2019-03-04 17:05 ` Bruce Richardson
2019-04-22 22:35 ` Thomas Monjalon
2019-04-22 22:35 ` Thomas Monjalon
2019-05-01 11:39 ` Mcnamara, John
2019-05-01 11:39 ` Mcnamara, John
2019-06-06 11:59 ` [dpdk-dev] [PATCH v6] " Hari Kumar Vemula
2019-07-08 19:40 ` Thomas Monjalon
2019-07-08 20:18 ` Aaron Conole
2019-07-09 18:57 ` Michael Santana Francisco
2019-07-22 12:39 ` Parthasarathy, JananeeX M
2019-07-22 12:53 ` Thomas Monjalon
2019-07-22 13:53 ` Bruce Richardson
2019-07-23 11:34 ` Parthasarathy, JananeeX M
2019-08-07 13:56 ` [dpdk-dev] [PATCH v7] " Agalya Babu RadhaKrishnan
2019-08-07 14:16 ` Jerin Jacob Kollanukkaran
2019-08-07 15:47 ` Michael Santana Francisco
2019-08-12 12:40 ` Jananee Parthasarathy [this message]
2020-02-16 10:28 ` [dpdk-dev] [PATCH v8] " Thomas Monjalon
2019-01-03 12:28 ` [dpdk-dev] [PATCH v2] eal: fix core number validation Hari kumar Vemula
2019-01-03 13:03 ` David Marchand
2019-01-07 7:05 ` Hari Kumar Vemula
2019-01-07 10:25 ` [dpdk-dev] [PATCH v3] " Hari Kumar Vemula
2019-01-10 10:11 ` David Marchand
2019-01-11 14:15 ` [dpdk-dev] [PATCH v4] " Hari Kumar Vemula
2019-01-11 15:06 ` David Marchand
2019-01-14 10:28 ` [dpdk-dev] [PATCH v5] " Hari Kumar Vemula
2019-01-14 14:39 ` David Marchand
2019-01-17 12:13 ` [dpdk-dev] [PATCH v6] " Hari Kumar Vemula
2019-01-17 12:19 ` Bruce Richardson
2019-01-17 12:32 ` David Marchand
2019-01-17 16:31 ` [dpdk-dev] [dpdk-stable] " Thomas Monjalon
2019-01-07 13:01 ` [dpdk-dev] [PATCH] net/bonding: fix create bonded device test failure Hari Kumar Vemula
2019-01-07 18:44 ` Chas Williams
2019-01-08 10:27 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
2019-01-08 11:14 ` [dpdk-dev] " Vemula, Hari KumarX
2019-01-15 17:37 ` Pattan, Reshma
2019-01-28 7:28 ` [dpdk-dev] [PATCH v2] " Hari Kumar Vemula
2019-01-31 23:40 ` Chas Williams
2019-02-05 13:39 ` [dpdk-dev] [PATCH v3] " Hari Kumar Vemula
2019-02-07 13:34 ` [dpdk-dev] [dpdk-stable] " Ferruh Yigit
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1565613625-6079-1-git-send-email-jananeex.m.parthasarathy@intel.com \
--to=jananeex.m.parthasarathy@intel.com \
--cc=bruce.richardson@intel.com \
--cc=dev@dpdk.org \
--cc=hari.kumarx.vemula@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=reshma.pattan@intel.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).