diff mbox series

[v1,1/1] .gitignore: Unignore .kunitconfig

Message ID 20230127145708.12915-1-andriy.shevchenko@linux.intel.com
State New
Headers show
Series [v1,1/1] .gitignore: Unignore .kunitconfig | expand

Commit Message

Andy Shevchenko Jan. 27, 2023, 2:57 p.m. UTC
There are almost dozen of .kunitconfig files that are ignored but
tracked. Unignore them.

Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
---
 .gitignore | 1 +
 1 file changed, 1 insertion(+)

Comments

David Gow Jan. 31, 2023, midnight UTC | #1
On Sat, 28 Jan 2023 at 22:37, Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Sat, Jan 28, 2023 at 3:56 PM David Gow <davidgow@google.com> wrote:
> >
> > On Fri, 27 Jan 2023 at 22:56, Andy Shevchenko
> > <andriy.shevchenko@linux.intel.com> wrote:
> > >
> > > There are almost dozen of .kunitconfig files that are ignored but
> > > tracked. Unignore them.
> > >
> > > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> > > ---
> >
> > Thanks! Only the original root-directory .kunitignore file was
> > intended to be ignored, and that's no longer as important, and is now
> > in the build dir anyway.
> >
> > Reviewed-by: David Gow <davidgow@google.com>
> >
> > Cheers,
> > -- David
> >
> > >  .gitignore | 1 +
> > >  1 file changed, 1 insertion(+)
> > >
> > > diff --git a/.gitignore b/.gitignore
> > > index 22984d22d29e..e4f2ba0be516 100644
> > > --- a/.gitignore
> > > +++ b/.gitignore
> > > @@ -100,6 +100,7 @@ modules.order
> > >  !.get_maintainer.ignore
> > >  !.gitattributes
> > >  !.gitignore
> > > +!.kunitconfig
> > >  !.mailmap
> > >  !.rustfmt.toml
> > >
> > > --
> > > 2.39.0
> > >
>
>
> Why is this a dot file in the first place?
>

In short, historical reasons.

The long answer is that there are two places "kunitconfig" files are
used: as a user-provided file with their preferred test config (which
is kept local), and as a recommended test config for a given subsystem
(which is checked in).
Originally, no .kunitconfig files were checked in: one was either
autogenerated or manually modified and left in the root source
directory. This eventually moved into the build directory, and a
number of features which de-emphasized it in favour of command-line
arguments and the (new) checked-in per-subsystem configs, which
probably shouldn't be hidden.

There's no fundamental reason (other than it being a bit annoying to
rename everything and update the code) we can't change it, either for
all kunitconfig files, or just the checked-in ones, if that's
preferred.

-- David
Masahiro Yamada Jan. 31, 2023, 2:11 a.m. UTC | #2
On Tue, Jan 31, 2023 at 9:01 AM David Gow <davidgow@google.com> wrote:
>
> On Sat, 28 Jan 2023 at 22:37, Masahiro Yamada <masahiroy@kernel.org> wrote:
> >
> > On Sat, Jan 28, 2023 at 3:56 PM David Gow <davidgow@google.com> wrote:
> > >
> > > On Fri, 27 Jan 2023 at 22:56, Andy Shevchenko
> > > <andriy.shevchenko@linux.intel.com> wrote:
> > > >
> > > > There are almost dozen of .kunitconfig files that are ignored but
> > > > tracked. Unignore them.
> > > >
> > > > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> > > > ---
> > >
> > > Thanks! Only the original root-directory .kunitignore file was
> > > intended to be ignored, and that's no longer as important, and is now
> > > in the build dir anyway.
> > >
> > > Reviewed-by: David Gow <davidgow@google.com>
> > >
> > > Cheers,
> > > -- David
> > >
> > > >  .gitignore | 1 +
> > > >  1 file changed, 1 insertion(+)
> > > >
> > > > diff --git a/.gitignore b/.gitignore
> > > > index 22984d22d29e..e4f2ba0be516 100644
> > > > --- a/.gitignore
> > > > +++ b/.gitignore
> > > > @@ -100,6 +100,7 @@ modules.order
> > > >  !.get_maintainer.ignore
> > > >  !.gitattributes
> > > >  !.gitignore
> > > > +!.kunitconfig
> > > >  !.mailmap
> > > >  !.rustfmt.toml
> > > >
> > > > --
> > > > 2.39.0
> > > >
> >
> >
> > Why is this a dot file in the first place?
> >
>
> In short, historical reasons.
>
> The long answer is that there are two places "kunitconfig" files are
> used: as a user-provided file with their preferred test config (which
> is kept local), and as a recommended test config for a given subsystem
> (which is checked in).
> Originally, no .kunitconfig files were checked in: one was either
> autogenerated or manually modified and left in the root source
> directory. This eventually moved into the build directory, and a
> number of features which de-emphasized it in favour of command-line
> arguments and the (new) checked-in per-subsystem configs, which
> probably shouldn't be hidden.


Do you mean there are two types for .kunitconfig - auto-generated ones
and check-in ones?

If this patch is applied, is there a possibility where
auto-generated .kunitconfig files would be accidentally
added to the repository?





> There's no fundamental reason (other than it being a bit annoying to
> rename everything and update the code) we can't change it, either for
> all kunitconfig files, or just the checked-in ones, if that's
> preferred.
>
> -- David
David Gow Jan. 31, 2023, 2:38 a.m. UTC | #3
On Tue, 31 Jan 2023 at 10:11, Masahiro Yamada <masahiroy@kernel.org> wrote:
>
> On Tue, Jan 31, 2023 at 9:01 AM David Gow <davidgow@google.com> wrote:
> >
> > On Sat, 28 Jan 2023 at 22:37, Masahiro Yamada <masahiroy@kernel.org> wrote:
> > >
> > > On Sat, Jan 28, 2023 at 3:56 PM David Gow <davidgow@google.com> wrote:
> > > >
> > > > On Fri, 27 Jan 2023 at 22:56, Andy Shevchenko
> > > > <andriy.shevchenko@linux.intel.com> wrote:
> > > > >
> > > > > There are almost dozen of .kunitconfig files that are ignored but
> > > > > tracked. Unignore them.
> > > > >
> > > > > Signed-off-by: Andy Shevchenko <andriy.shevchenko@linux.intel.com>
> > > > > ---
> > > >
> > > > Thanks! Only the original root-directory .kunitignore file was
> > > > intended to be ignored, and that's no longer as important, and is now
> > > > in the build dir anyway.
> > > >
> > > > Reviewed-by: David Gow <davidgow@google.com>
> > > >
> > > > Cheers,
> > > > -- David
> > > >
> > > > >  .gitignore | 1 +
> > > > >  1 file changed, 1 insertion(+)
> > > > >
> > > > > diff --git a/.gitignore b/.gitignore
> > > > > index 22984d22d29e..e4f2ba0be516 100644
> > > > > --- a/.gitignore
> > > > > +++ b/.gitignore
> > > > > @@ -100,6 +100,7 @@ modules.order
> > > > >  !.get_maintainer.ignore
> > > > >  !.gitattributes
> > > > >  !.gitignore
> > > > > +!.kunitconfig
> > > > >  !.mailmap
> > > > >  !.rustfmt.toml
> > > > >
> > > > > --
> > > > > 2.39.0
> > > > >
> > >
> > >
> > > Why is this a dot file in the first place?
> > >
> >
> > In short, historical reasons.
> >
> > The long answer is that there are two places "kunitconfig" files are
> > used: as a user-provided file with their preferred test config (which
> > is kept local), and as a recommended test config for a given subsystem
> > (which is checked in).
> > Originally, no .kunitconfig files were checked in: one was either
> > autogenerated or manually modified and left in the root source
> > directory. This eventually moved into the build directory, and a
> > number of features which de-emphasized it in favour of command-line
> > arguments and the (new) checked-in per-subsystem configs, which
> > probably shouldn't be hidden.
>
>
> Do you mean there are two types for .kunitconfig - auto-generated ones
> and check-in ones?
>
> If this patch is applied, is there a possibility where
> auto-generated .kunitconfig files would be accidentally
> added to the repository?
>
>

I wouldn't think so -- the auto-generated ones live in the build
directory (which is itself '.kunit' by default). You'd have to go out
of your way to do an in-tree build, and then add generated files.

-- David
diff mbox series

Patch

diff --git a/.gitignore b/.gitignore
index 22984d22d29e..e4f2ba0be516 100644
--- a/.gitignore
+++ b/.gitignore
@@ -100,6 +100,7 @@  modules.order
 !.get_maintainer.ignore
 !.gitattributes
 !.gitignore
+!.kunitconfig
 !.mailmap
 !.rustfmt.toml