DPDK patches and discussions
 help / color / mirror / Atom feed
From: Aaron Conole <aconole@redhat.com>
To: Bruce Richardson <bruce.richardson@intel.com>
Cc: David Marchand <david.marchand@redhat.com>, dev <dev@dpdk.org>,
	Ray Kinsella <mdr@ashroe.eu>
Subject: Re: [dpdk-dev] [PATCH v2] guides: add a testing guide for developing tests
Date: Tue, 02 Mar 2021 10:26:59 -0500	[thread overview]
Message-ID: <f7t7dmpvanw.fsf@dhcp-25.97.bos.redhat.com> (raw)
In-Reply-To: <20210302100401.GA1396@bricha3-MOBL.ger.corp.intel.com> (Bruce Richardson's message of "Tue, 2 Mar 2021 10:04:01 +0000")

Bruce Richardson <bruce.richardson@intel.com> writes:

> On Tue, Mar 02, 2021 at 10:07:26AM +0100, David Marchand wrote:
>> On Wed, Feb 10, 2021 at 3:56 PM Aaron Conole <aconole@redhat.com> wrote:
>> > diff --git a/doc/guides/contributing/testing.rst b/doc/guides/contributing/testing.rst
>> > new file mode 100644
>> > index 0000000000..86ca24ce43
>> > --- /dev/null
>> > +++ b/doc/guides/contributing/testing.rst
>> > @@ -0,0 +1,245 @@
>> > +..  SPDX-License-Identifier: BSD-3-Clause
>> > +    Copyright 2018 The DPDK contributors
>> 
>> 2021?

Whoops, I forgot to update my time machine.

>> > +
>> > +.. _testing_guidelines:
>> 
>> I can't find a call to the testing_guidelines reference, so this can be removed.

done.

>> 
>> [snip]
>> 
>> > +The suites can be selected by adding the ``--suite`` option to the
>> > +``meson test`` command.  Ex: ``meson test --suite fast-tests``::
>> > +
>> > +  $ meson test -C build --suite fast-tests
>> > +  ninja: Entering directory `/home/aconole/git/dpdk/build'
>> > +  [2543/2543] Linking target app/test/dpdk-test.
>> > +  1/60 DPDK:fast-tests / acl_autotest          OK       3.17 s
>> > +  2/60 DPDK:fast-tests / bitops_autotest       OK       0.22 s
>> > +  3/60 DPDK:fast-tests / byteorder_autotest    OK       0.22 s
>> > +  4/60 DPDK:fast-tests / cmdline_autotest      OK       0.28 s
>> > +  5/60 DPDK:fast-tests / common_autotest       OK       0.57 s
>> > +  6/60 DPDK:fast-tests / cpuflags_autotest     OK       0.27 s
>> > +  ...
>> 
>> Trying this in my build env, I get all tests failing.
>> This is because I run this as a normal user, but the system has
>> hugepages configured.
>> I figured this out quickly since I know the test framework (simply
>> added a echo 0; exit at the top of has-hugepages.sh).
>> But I am not sure a reader of this doc would be able to troubleshoot this.
>> 
>> Not sure if this is worth explaining here, or if we can enhance the
>> hugepage check (permissions maybe?).

I prefer to fix the hugepage check to make the tests SKIP when we don't
have hugepages accessible (so we need some kind of permission check in
there).  I will submit it separately.

>> 
>> [snip]
>> 
>> > +Checking code coverage
>> > +----------------------
>> > +The meson build system supports generating a code coverage report
>> > +via the `-Db_coverage=true` option, in conjunction with a package
>> > +like **lcov**, to generate an HTML code coverage report.  Example::
>> > +
>> > +  $ meson covered -Db_coverage=true
>> 
>> At first, I read "covered" as a meson command :-).
>> I prefer an explicit "meson setup covered -Db_coverage=true", but well
>> this is more a matter of taste.
>> 
>>
>
> I also tend to prefer the build directory name at the end of the command,
> so I'd suggest: "meson setup -Db_coverage=true covered".  Furthermore,
> while I can understand the use of "covered" as a build directory name, I
> think for consistency across all docs, we should just use "build" here as
> the directory name, which again will reduce confusion.  "meson setup
> -Db_coverage build"

Okay - I will paint this bikeshed like:

   meson setup build -Db_coverage=true

It's a little inconsistent everywhere - so I guess a good janitor
project would be to clean up all the places we have meson commands.

Otherwise, what I've found is that the options generally come after the
build directory / command is specified (ex: see octeontx, the arm64
cross build docs, etc.) so I'll keep that for consistency there.
Hopefully we will consistently become more consistent :)

> /Bruce 


  reply	other threads:[~2021-03-02 15:27 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-02-08 16:52 [dpdk-dev] [PATCH] " Aaron Conole
2021-02-08 18:03 ` Kinsella, Ray
2021-02-09 20:02   ` Aaron Conole
2021-02-10 14:55 ` [dpdk-dev] [PATCH v2] " Aaron Conole
2021-03-02  9:07   ` David Marchand
2021-03-02 10:04     ` Bruce Richardson
2021-03-02 15:26       ` Aaron Conole [this message]
2021-03-02 16:00         ` Bruce Richardson
2021-03-09 16:14         ` Aaron Conole
2021-03-11 21:25           ` David Marchand
2021-03-17 14:44             ` Aaron Conole
2021-03-09 15:57   ` [dpdk-dev] [PATCH v3] guides: add a guide for developing unit tests Aaron Conole
2021-05-31 15:17     ` Ferruh Yigit
2021-06-01 13:11       ` Aaron Conole
2021-07-14 16:40     ` [dpdk-dev] [PATCH v4] " Aaron Conole
2021-08-04 16:25       ` Power, Ciara
2021-08-06  9:27       ` Zhang, Roy Fan
2021-08-06  9:53       ` Mcnamara, John
2021-10-15 17:06       ` [dpdk-dev] [PATCH v5] " Aaron Conole
2021-11-26 16:20         ` Thomas Monjalon

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=f7t7dmpvanw.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=mdr@ashroe.eu \
    /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).