diff mbox series

[v2,2/3] lib/linear_ranges_kunit: Follow new file name convention for KUnit tests

Message ID 20201015184416.38999-2-andriy.shevchenko@linux.intel.com
State New
Headers show
Series [v2,1/3] lib/list_kunit: Follow new file name convention for KUnit tests | expand

Commit Message

Andy Shevchenko Oct. 15, 2020, 6:44 p.m. UTC
Follow new file name convention for the KUnit tests.
Since we have lib/*test*.c in a few variations,
use 'kunit' suffix to distinguish usual test cases
with KUnit-based ones.

Cc: Mark Brown <broonie@kernel.org>
Cc: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
v2: new patch
 MAINTAINERS                                         | 3 +--
 lib/Makefile                                        | 2 +-
 lib/{test_linear_ranges.c => linear_ranges_kunit.c} | 0
 3 files changed, 2 insertions(+), 3 deletions(-)
 rename lib/{test_linear_ranges.c => linear_ranges_kunit.c} (100%)

Comments

David Gow Oct. 16, 2020, 5:02 a.m. UTC | #1
On Fri, Oct 16, 2020 at 2:44 AM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> Follow new file name convention for the KUnit tests.
> Since we have lib/*test*.c in a few variations,
> use 'kunit' suffix to distinguish usual test cases
> with KUnit-based ones.
>
> Cc: Mark Brown <broonie@kernel.org>
> Cc: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>

Thanks. This looks good to me from an "I tested it and it worked" and
a "matches the naming guidelines" point of view.

(Since the naming documentation isn't actually in Linus' branch yet,
I'll drop a link to it here:
https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
)

I'm not the test author though, and the naming doc does explicitly
leave the possibility of keeping the old filenames for tests if
there's a particularly good reason to (e.g., a lot depending on the
module name). I'm not aware of any such thing, and so am in favour of
the rename, but will defer to the test authors on that point if they
object.

Either way,
Reviewed-by: David Gow <davidgow@google.com>

Cheers,
-- David
Andy Shevchenko Oct. 16, 2020, 9:29 a.m. UTC | #2
On Fri, Oct 16, 2020 at 01:02:20PM +0800, David Gow wrote:
> On Fri, Oct 16, 2020 at 2:44 AM Andy Shevchenko
> <andriy.shevchenko@linux.intel.com> wrote:
> >
> > Follow new file name convention for the KUnit tests.
> > Since we have lib/*test*.c in a few variations,
> > use 'kunit' suffix to distinguish usual test cases
> > with KUnit-based ones.
> >
> > Cc: Mark Brown <broonie@kernel.org>
> > Cc: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> 
> Thanks. This looks good to me from an "I tested it and it worked" and
> a "matches the naming guidelines" point of view.
> 
> (Since the naming documentation isn't actually in Linus' branch yet,
> I'll drop a link to it here:
> https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
> )
> 
> I'm not the test author though, and the naming doc does explicitly
> leave the possibility of keeping the old filenames for tests if
> there's a particularly good reason to (e.g., a lot depending on the
> module name).

Can you point out to this? Briefly looking into I haven't found that.

> I'm not aware of any such thing, and so am in favour of
> the rename, but will defer to the test authors on that point if they
> object.

> Either way,
> Reviewed-by: David Gow <davidgow@google.com>

Thanks!
Mark Brown Oct. 16, 2020, 10:38 a.m. UTC | #3
On Thu, Oct 15, 2020 at 09:44:15PM +0300, Andy Shevchenko wrote:
> Follow new file name convention for the KUnit tests.
> Since we have lib/*test*.c in a few variations,
> use 'kunit' suffix to distinguish usual test cases
> with KUnit-based ones.

I'm missing the rest of this series - what's the story with dependencies
here?
Andy Shevchenko Oct. 16, 2020, 11:03 a.m. UTC | #4
On Fri, Oct 16, 2020 at 11:38:41AM +0100, Mark Brown wrote:
> On Thu, Oct 15, 2020 at 09:44:15PM +0300, Andy Shevchenko wrote:
> > Follow new file name convention for the KUnit tests.
> > Since we have lib/*test*.c in a few variations,
> > use 'kunit' suffix to distinguish usual test cases
> > with KUnit-based ones.
> 
> I'm missing the rest of this series - what's the story with dependencies
> here?

There is a dependency in Makefile. Do you want me to send a new version with
Cc'ing you all?
Andy Shevchenko Oct. 16, 2020, 11:10 a.m. UTC | #5
On Fri, Oct 16, 2020 at 02:03:44PM +0300, Andy Shevchenko wrote:
> On Fri, Oct 16, 2020 at 11:38:41AM +0100, Mark Brown wrote:
> > On Thu, Oct 15, 2020 at 09:44:15PM +0300, Andy Shevchenko wrote:

> > I'm missing the rest of this series - what's the story with dependencies
> > here?
> 
> There is a dependency in Makefile. Do you want me to send a new version with
> Cc'ing you all?

v3 has been sent.
Mark Brown Oct. 16, 2020, 11:12 a.m. UTC | #6
On Fri, Oct 16, 2020 at 02:03:44PM +0300, Andy Shevchenko wrote:
> On Fri, Oct 16, 2020 at 11:38:41AM +0100, Mark Brown wrote:

> > I'm missing the rest of this series - what's the story with dependencies
> > here?

> There is a dependency in Makefile. Do you want me to send a new version with
> Cc'ing you all?

It's fine this time but please don't do this in future, people need at
least a cover letter so they know how things rae related to each other.
David Gow Oct. 17, 2020, 6:57 a.m. UTC | #7
On Fri, Oct 16, 2020 at 5:29 PM Andy Shevchenko
<andriy.shevchenko@linux.intel.com> wrote:
>
> On Fri, Oct 16, 2020 at 01:02:20PM +0800, David Gow wrote:
> > On Fri, Oct 16, 2020 at 2:44 AM Andy Shevchenko
> > <andriy.shevchenko@linux.intel.com> wrote:
> > >
> > > Follow new file name convention for the KUnit tests.
> > > Since we have lib/*test*.c in a few variations,
> > > use 'kunit' suffix to distinguish usual test cases
> > > with KUnit-based ones.
> > >
> > > Cc: Mark Brown <broonie@kernel.org>
> > > Cc: Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
> > > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> >
> > Thanks. This looks good to me from an "I tested it and it worked" and
> > a "matches the naming guidelines" point of view.
> >
> > (Since the naming documentation isn't actually in Linus' branch yet,
> > I'll drop a link to it here:
> > https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit
> > )
> >
> > I'm not the test author though, and the naming doc does explicitly
> > leave the possibility of keeping the old filenames for tests if
> > there's a particularly good reason to (e.g., a lot depending on the
> > module name).
>
> Can you point out to this? Briefly looking into I haven't found that.

This was what was intended by the first "exemption" listed[1] at the
beginning of the document:
"It's recommended that you only deviate from these guidelines when:
[...] Porting tests to KUnit which are already known with an existing
name"

Admittedly, this test was originally a KUnit test, rather than a port
of another test, so the exact wording probably doesn't apply here, but
that's more an artefact of the naming guidelines landing after this
test did.

The goal here is really just to make sure that existing test modules
can be ported to KUnit without breaking existing users which may
depend on the name. It doesn't look like that applies for this test,
though.

Cheers,
-- David

[1]: https://git.kernel.org/pub/scm/linux/kernel/git/shuah/linux-kselftest.git/tree/Documentation/dev-tools/kunit/style.rst?h=kunit#n13
diff mbox series

Patch

diff --git a/MAINTAINERS b/MAINTAINERS
index 20facbca9388..249417a036f9 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -10069,8 +10069,7 @@  F:	include/uapi/linux/lightnvm.h
 LINEAR RANGES HELPERS
 M:	Mark Brown <broonie@kernel.org>
 R:	Matti Vaittinen <matti.vaittinen@fi.rohmeurope.com>
-F:	lib/linear_ranges.c
-F:	lib/test_linear_ranges.c
+F:	lib/linear_ranges*.c
 F:	include/linux/linear_range.h
 
 LINUX FOR POWER MACINTOSH
diff --git a/lib/Makefile b/lib/Makefile
index 1a5e6a6ebe8d..5c18519d6733 100644
--- a/lib/Makefile
+++ b/lib/Makefile
@@ -350,6 +350,6 @@  obj-$(CONFIG_PLDMFW) += pldmfw/
 
 # KUnit tests
 obj-$(CONFIG_BITFIELD_KUNIT) += bitfield_kunit.o
+obj-$(CONFIG_LINEAR_RANGES_TEST) += linear_ranges_kunit.o
 obj-$(CONFIG_LIST_KUNIT_TEST) += list_kunit.o
-obj-$(CONFIG_LINEAR_RANGES_TEST) += test_linear_ranges.o
 obj-$(CONFIG_BITS_TEST) += test_bits.o
diff --git a/lib/test_linear_ranges.c b/lib/linear_ranges_kunit.c
similarity index 100%
rename from lib/test_linear_ranges.c
rename to lib/linear_ranges_kunit.c