qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: Wainer dos Santos Moschetta <wainersm@redhat.com>
To: John Snow <jsnow@redhat.com>, qemu-devel@nongnu.org
Cc: qemu-trivial@nongnu.org, pbonzini@redhat.com, thuth@redhat.com
Subject: Re: [PATCH] docs/devel/testing.rst: Fix referencies to unit tests
Date: Thu, 18 Mar 2021 09:54:40 -0300	[thread overview]
Message-ID: <14698b63-d3ab-eb9c-d450-6ee95d1e40a7@redhat.com> (raw)
In-Reply-To: <6cd5da6e-c7d1-5eba-d842-4983671f5db8@redhat.com>


On 3/17/21 6:55 PM, John Snow wrote:
> typo in the commit summary; "references to"
>
> On 3/17/21 3:48 PM, Wainer dos Santos Moschetta wrote:
>> With the recent move of the unit tests to tests/unit directory some
>> instructions under the "Unit tests" section became imprecise, which
>> are fixed by this change.
>>
>> Related-to: da668aa15b99 (tests: Move unit tests into a separate 
>> directory)
>
> You can probably just use "Fixes", even though nothing is technically 
> broken to avoid introducing a new one-off tag type.

Yeah, I wasn't sure whether to use "Fixes" or not. Thanks for the tip!

Going to send a v2 to fix those issues.

- Wainer

>
>
>> Signed-off-by: Wainer dos Santos Moschetta <wainersm@redhat.com>
>> ---
>>   docs/devel/testing.rst | 6 +++---
>>   1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/docs/devel/testing.rst b/docs/devel/testing.rst
>> index 1434a50cc4..1da4c4e4c4 100644
>> --- a/docs/devel/testing.rst
>> +++ b/docs/devel/testing.rst
>> @@ -34,17 +34,17 @@ If you are writing new code in QEMU, consider 
>> adding a unit test, especially
>>   for utility modules that are relatively stateless or have few 
>> dependencies. To
>>   add a new unit test:
>>   -1. Create a new source file. For example, ``tests/foo-test.c``.
>> +1. Create a new source file. For example, ``tests/unit/foo-test.c``.
>>     2. Write the test. Normally you would include the header file 
>> which exports
>>      the module API, then verify the interface behaves as expected 
>> from your
>>      test. The test code should be organized with the glib testing 
>> framework.
>>      Copying and modifying an existing test is usually a good idea.
>>   -3. Add the test to ``tests/meson.build``. The unit tests are 
>> listed in a
>> +3. Add the test to ``tests/unit/meson.build``. The unit tests are 
>> listed in a
>>      dictionary called ``tests``.  The values are any additional 
>> sources and
>>      dependencies to be linked with the test.  For a simple test 
>> whose source
>> -   is in ``tests/foo-test.c``, it is enough to add an entry like::
>> +   is in ``tests/unit/foo-test.c``, it is enough to add an entry like::
>>          {
>>          ...
>>
>



  reply	other threads:[~2021-03-18 12:56 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-03-17 19:48 [PATCH] docs/devel/testing.rst: Fix referencies to unit tests Wainer dos Santos Moschetta
2021-03-17 21:55 ` John Snow
2021-03-18 12:54   ` Wainer dos Santos Moschetta [this message]
2021-03-18  5:10 ` Thomas Huth

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=14698b63-d3ab-eb9c-d450-6ee95d1e40a7@redhat.com \
    --to=wainersm@redhat.com \
    --cc=jsnow@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-trivial@nongnu.org \
    --cc=thuth@redhat.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).