From: Aaron Conole <aconole@redhat.com>
To: Thomas Monjalon <thomas@monjalon.net>
Cc: Hari Kumar Vemula <hari.kumarx.vemula@intel.com>,
dev@dpdk.org, reshma.pattan@intel.com, john.mcnamara@intel.com,
marko.kovacevic@intel.com, jananeex.m.parthasarathy@intel.com,
bruce.richardson@intel.com, david.marchand@redhat.com
Subject: Re: [dpdk-dev] [PATCH v6] doc: add meson ut info in prog guide
Date: Mon, 08 Jul 2019 16:18:16 -0400 [thread overview]
Message-ID: <f7ta7doxotz.fsf@dhcp-25.97.bos.redhat.com> (raw)
In-Reply-To: <111637960.86sdBQFhhs@xps> (Thomas Monjalon's message of "Mon, 08 Jul 2019 21:40:44 +0200")
Thomas Monjalon <thomas@monjalon.net> writes:
> Hi please find some comments below:
>
> 06/06/2019 13:59, Hari Kumar Vemula:
>> +++ b/doc/guides/prog_guide/meson_ut.rst
>> @@ -0,0 +1,151 @@
>> +.. SPDX-License-Identifier: BSD-3-Clause
>> +
>
> Useless blank line.
>
>> + Copyright(c) 2018-2019 Intel Corporation.
>> +
>> +.. _meson_unit_tests:
>
> Useless anchor. The doc can be referenced with :doc: links.
>
>> +
>> +Running DPDK Unit Tests with Meson
>> +==================================
>> +
>> +This section describes how to run testcases with the DPDK meson build system.
>
> Here and below, "testcases" should be split in two words.
>
>> +
>> +
>> +Building and running the unit tests
>> +-----------------------------------
>> +
>> +* Create the meson build output folder using the following command::
>> +
>> + $ meson <build_dir>
>> +
>> +* Enter into build output folder, which was created by above command::
>> +
>> + $ cd build
>
> Should be the same as above: <build_dir>
>
>> +
>> +* Compile DPDK using command::
>> +
>> + $ ninja
>
> Do we really need to repeat above basic steps?
> Would be easier to just reference another guide about meson.
> I think doc/build-sdk-meson.txt should be moved to .rst.
+1
>> +
>> +The output file of the build will be available in meson build folder. After
>> +a successful ninja command, the binary ``dpdk-test`` is created in
>> +``build/test/test/``.
>
> Again, "build" is an example directory.
>
>> +
>> +* Run the unit testcases::
>> +
>> + $ ninja test
>> + # or
>> + $ meson test
>> +
>> +* To run specific test case via meson::
>> +
>> + $ meson test <test case>
>> + # or
>> + $ ninja test <test case>
>
> Would be worth to mention why meson or ninja can be used.
>
>> +
>> +
>> +Grouping of testcases
>> +---------------------
>> +
>> +Testcases have been grouped into four different groups based on conditions
>> +of time duration and performance of the individual testcase.
>
> Grouping has changed recently.
> This part should be updated please.
>
>> +
>> +* Fast tests which can be run in parallel.
>> +* Fast tests which must run serially.
>> +* Performance tests.
>> +* Driver tests.
>> +* Tests which produce lists of objects as output, and therefore that need
>> + manual checking.
>> +
>> +Testcases can be run in parallel or non-parallel mode using the ``is_parallel`` argument
>> +of ``test()`` in meson.build
>> +
>> +These tests can be run using the argument to ``meson test`` as
>> +``--suite project_name:label``.
>> +
>> +For example::
>> +
>> + $ 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
>> +
>> +
>> +Running different test suites
>> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
>> +
>> +The following commands are some examples of how to run testcases using option
>> +``--suite``:
The following section is a bit misleading. The limitation on run time
is per-test. So 600 seconds in perf-tests is 600 seconds PER TEST. IE:
if there are 10 tests, you'll be waiting up to 50 minutes.
>> +* Fast Tests should take less than 10 seconds. The meson command to run them
>> + is::
>> +
>> + $ meson test --suite DPDK:fast-tests
>> +
>> +* Performance Tests should take less than 600 seconds. The meson command to
>> + run them is::
>> +
>> + $ meson test --suite DPDK:perf-tests
>> +
>> +* Driver Tests should take less than 600 seconds. The meson command to run
>> + them is::
>> +
>> + $ meson test --suite DPDK:driver-tests
>> +
>> +* The meson command to run Dump Tests is::
>> +
>> + $ meson test --suite DPDK:dump-tests
>
> Would be simpler to just list the suites.
Even better would be to provide a 1-liner that would dump the suites so
that new test suites wouldn't need to update the documentation.
>> +
>> +
>> +Dealing with skipped testcases
>> +------------------------------
>> +
>> +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.
>> +
>> +To help find missing libraries, the user can specify addition search paths
>
> addition -> additional ?
>
>> +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
>
> Some quotes are missing to set multiple paths.
>
>> +
>> +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
>
> Why export is used for LIBRARY_PATH and not CFLAGS?
> I think both variables can be exported or prepend the meson command?
next prev parent reply other threads:[~2019-07-08 20:18 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 [this message]
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 ` [dpdk-dev] [PATCH v8] " Jananee Parthasarathy
2020-02-16 10:28 ` 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=f7ta7doxotz.fsf@dhcp-25.97.bos.redhat.com \
--to=aconole@redhat.com \
--cc=bruce.richardson@intel.com \
--cc=david.marchand@redhat.com \
--cc=dev@dpdk.org \
--cc=hari.kumarx.vemula@intel.com \
--cc=jananeex.m.parthasarathy@intel.com \
--cc=john.mcnamara@intel.com \
--cc=marko.kovacevic@intel.com \
--cc=reshma.pattan@intel.com \
--cc=thomas@monjalon.net \
/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).