Recent git versions do not accept the noted command.
$ git ls-files -i --exclude-standard
fatal: ls-files -i must be used with either -o or -c
The -c was implied for older git versions, but we need to make it
explicit now.
Also, replace --exclude-standard with --exclude-per-directory=.gitignore
so that everyone will get consistent results.
git-ls-files(1) says:
--exclude-standard
Add the standard Git exclusions: .git/info/exclude, .gitignore in
each directory, and the user's global exclusion file.
We never know what are locally added to $GIT_DIR/info/exclude or
$XDG_CONFIG_HOME/git/ignore.
We can only manage .gitignore files committed in the repository.
Signed-off-by: Masahiro Yamada <[email protected]>
---
(no changes since v1)
.gitignore | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/.gitignore b/.gitignore
index 3ec73ead6757..2e2e3d1eeaee 100644
--- a/.gitignore
+++ b/.gitignore
@@ -4,7 +4,7 @@
# subdirectories here. Add them in the ".gitignore" file
# in that subdirectory instead.
#
-# NOTE! Please use 'git ls-files -i --exclude-standard'
+# NOTE! Please use 'git ls-files -i -c --exclude-per-directory=.gitignore'
# command after changing this file, to see if there are
# any tracked files which get ignored after the change.
#
--
2.34.1
The top .gitignore comments about how to detect files breaking
.gitignore rules, but people rarely care about it.
Add a new W=1 warning to detect files that are tracked but ignored by
git. If git is not installed or the source tree is not tracked by git
at all, this script does not print anything.
Running it on the v6.1 kernel detected the following:
$ make W=1 misc-check
Documentation/devicetree/bindings/.yamllint: warning: ignored by one of the .gitignore files
drivers/clk/.kunitconfig: warning: ignored by one of the .gitignore files
drivers/gpu/drm/tests/.kunitconfig: warning: ignored by one of the .gitignore files
drivers/hid/.kunitconfig: warning: ignored by one of the .gitignore files
fs/ext4/.kunitconfig: warning: ignored by one of the .gitignore files
fs/fat/.kunitconfig: warning: ignored by one of the .gitignore files
kernel/kcsan/.kunitconfig: warning: ignored by one of the .gitignore files
lib/kunit/.kunitconfig: warning: ignored by one of the .gitignore files
mm/kfence/.kunitconfig: warning: ignored by one of the .gitignore files
tools/testing/selftests/arm64/tags/.gitignore: warning: ignored by one of the .gitignore files
tools/testing/selftests/arm64/tags/Makefile: warning: ignored by one of the .gitignore files
tools/testing/selftests/arm64/tags/run_tags_test.sh: warning: ignored by one of the .gitignore files
tools/testing/selftests/arm64/tags/tags_test.c: warning: ignored by one of the .gitignore files
These are ignored by the '.*' or 'tags' in the top .gitignore, but
there is no rule to negate it.
You might be tempted to do 'git add -f' but I want to have the real
issue fixed (by fixing a .gitignore, or by renaming files, etc.).
Signed-off-by: Masahiro Yamada <[email protected]>
---
Changes in v2:
- Add $(srctree)/ to make it work with O=
Makefile | 6 ++++++
scripts/misc-check | 19 +++++++++++++++++++
2 files changed, 25 insertions(+)
create mode 100755 scripts/misc-check
diff --git a/Makefile b/Makefile
index 44239352d2bf..f6ff8f77a669 100644
--- a/Makefile
+++ b/Makefile
@@ -1852,6 +1852,12 @@ rust-analyzer:
# Misc
# ---------------------------------------------------------------------------
+PHONY += misc-check
+misc-check:
+ $(Q)$(srctree)/scripts/misc-check
+
+all: misc-check
+
PHONY += scripts_gdb
scripts_gdb: prepare0
$(Q)$(MAKE) $(build)=scripts/gdb
diff --git a/scripts/misc-check b/scripts/misc-check
new file mode 100755
index 000000000000..bf68712d1ac1
--- /dev/null
+++ b/scripts/misc-check
@@ -0,0 +1,19 @@
+#!/bin/sh
+# SPDX-License-Identifier: GPL-2.0-only
+
+set -e
+
+# Detect files that are tracked but ignored by git. This is checked only when
+# ${KBUILD_EXTRA_WARN} contains 1, git is installed, and the source tree is
+# tracked by git.
+check_tracked_ignored_files () {
+ case "${KBUILD_EXTRA_WARN}" in
+ *1*) ;;
+ *) return;;
+ esac
+
+ git ls-files -i -c --exclude-per-directory=.gitignore 2>/dev/null |
+ sed 's/$/: warning: ignored by one of the .gitignore files/' >&2
+}
+
+check_tracked_ignored_files
--
2.34.1
Hi Masahiro,
I love your patch! Perhaps something to improve:
[auto build test WARNING on masahiroy-kbuild/for-next]
[also build test WARNING on masahiroy-kbuild/fixes linus/master v6.1 next-20221220]
[If your patch is applied to the wrong git tree, kindly drop us a note.
And when submitting patch, we suggest to use '--base' as documented in
https://git-scm.com/docs/git-format-patch#_base_tree_information]
url: https://github.com/intel-lab-lkp/linux/commits/Masahiro-Yamada/kbuild-make-W-1-warn-files-that-are-tracked-but-ignored-by-git/20221224-235253
base: https://git.kernel.org/pub/scm/linux/kernel/git/masahiroy/linux-kbuild.git for-next
patch link: https://lore.kernel.org/r/20221224155138.447912-2-masahiroy%40kernel.org
patch subject: [PATCH v2 2/2] kbuild: make W=1 warn files that are tracked but ignored by git
config: openrisc-randconfig-r024-20221225
compiler: or1k-linux-gcc (GCC) 12.1.0
reproduce (this is a W=1 build):
wget https://raw.githubusercontent.com/intel/lkp-tests/master/sbin/make.cross -O ~/bin/make.cross
chmod +x ~/bin/make.cross
# https://github.com/intel-lab-lkp/linux/commit/906c2c5c0c3230103325b146ec511fbb18d57cd1
git remote add linux-review https://github.com/intel-lab-lkp/linux
git fetch --no-tags linux-review Masahiro-Yamada/kbuild-make-W-1-warn-files-that-are-tracked-but-ignored-by-git/20221224-235253
git checkout 906c2c5c0c3230103325b146ec511fbb18d57cd1
# save the config file
mkdir build_dir && cp config build_dir/.config
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc olddefconfig
COMPILER_INSTALL_PATH=$HOME/0day COMPILER=gcc-12.1.0 make.cross W=1 O=build_dir ARCH=openrisc SHELL=/bin/bash
If you fix the issue, kindly add following tag where applicable
| Reported-by: kernel test robot <[email protected]>
All warnings (new ones prefixed by >>):
>> Documentation/devicetree/bindings/.yamllint: warning: ignored by one of the .gitignore files
>> drivers/clk/.kunitconfig: warning: ignored by one of the .gitignore files
>> drivers/gpu/drm/tests/.kunitconfig: warning: ignored by one of the .gitignore files
>> drivers/hid/.kunitconfig: warning: ignored by one of the .gitignore files
>> fs/ext4/.kunitconfig: warning: ignored by one of the .gitignore files
>> fs/fat/.kunitconfig: warning: ignored by one of the .gitignore files
>> kernel/kcsan/.kunitconfig: warning: ignored by one of the .gitignore files
>> lib/kunit/.kunitconfig: warning: ignored by one of the .gitignore files
>> mm/kfence/.kunitconfig: warning: ignored by one of the .gitignore files
>> tools/testing/selftests/arm64/tags/.gitignore: warning: ignored by one of the .gitignore files
>> tools/testing/selftests/arm64/tags/Makefile: warning: ignored by one of the .gitignore files
>> tools/testing/selftests/arm64/tags/run_tags_test.sh: warning: ignored by one of the .gitignore files
>> tools/testing/selftests/arm64/tags/tags_test.c: warning: ignored by one of the .gitignore files
--
0-DAY CI Kernel Test Service
https://01.org/lkp
On Sat, Dec 24, 2022 at 4:51 PM Masahiro Yamada <[email protected]> wrote:
>
> The -c was implied for older git versions, but we need to make it
> explicit now.
Perhaps add a `Link:` to Git's commit b338e9f66873 ("ls-files: error
out on -i unless -o or -c are specified")
https://git.kernel.org/pub/scm/git/git.git/commit/?id=b338e9f668737e08201c990450b8c3d744f63162
> We never know what are locally added to $GIT_DIR/info/exclude or
> $XDG_CONFIG_HOME/git/ignore.
Perhaps we could say "global exclusion file" instead (since it could
be the one from `core.excludesFile` too).
> Signed-off-by: Masahiro Yamada <[email protected]>
By the way, in the commit title: "gitinogre" -> "gitignore"
Reviewed-by: Miguel Ojeda <[email protected]>
Cheers,
Miguel
On Sun, Dec 25, 2022 at 12:51:38AM +0900, Masahiro Yamada wrote:
> The top .gitignore comments about how to detect files breaking
> .gitignore rules, but people rarely care about it.
>
> Add a new W=1 warning to detect files that are tracked but ignored by
> git. If git is not installed or the source tree is not tracked by git
> at all, this script does not print anything.
>
> Running it on the v6.1 kernel detected the following:
>
> $ make W=1 misc-check
> Documentation/devicetree/bindings/.yamllint: warning: ignored by one of the .gitignore files
> drivers/clk/.kunitconfig: warning: ignored by one of the .gitignore files
> drivers/gpu/drm/tests/.kunitconfig: warning: ignored by one of the .gitignore files
> drivers/hid/.kunitconfig: warning: ignored by one of the .gitignore files
> fs/ext4/.kunitconfig: warning: ignored by one of the .gitignore files
> fs/fat/.kunitconfig: warning: ignored by one of the .gitignore files
> kernel/kcsan/.kunitconfig: warning: ignored by one of the .gitignore files
> lib/kunit/.kunitconfig: warning: ignored by one of the .gitignore files
> mm/kfence/.kunitconfig: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/.gitignore: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/Makefile: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/run_tags_test.sh: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/tags_test.c: warning: ignored by one of the .gitignore files
>
> These are ignored by the '.*' or 'tags' in the top .gitignore, but
> there is no rule to negate it.
>
> You might be tempted to do 'git add -f' but I want to have the real
> issue fixed (by fixing a .gitignore, or by renaming files, etc.).
>
> Signed-off-by: Masahiro Yamada <[email protected]>
Reviewed-by: Nathan Chancellor <[email protected]>
> ---
>
> Changes in v2:
> - Add $(srctree)/ to make it work with O=
>
> Makefile | 6 ++++++
> scripts/misc-check | 19 +++++++++++++++++++
> 2 files changed, 25 insertions(+)
> create mode 100755 scripts/misc-check
>
> diff --git a/Makefile b/Makefile
> index 44239352d2bf..f6ff8f77a669 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1852,6 +1852,12 @@ rust-analyzer:
> # Misc
> # ---------------------------------------------------------------------------
>
> +PHONY += misc-check
> +misc-check:
> + $(Q)$(srctree)/scripts/misc-check
> +
> +all: misc-check
> +
> PHONY += scripts_gdb
> scripts_gdb: prepare0
> $(Q)$(MAKE) $(build)=scripts/gdb
> diff --git a/scripts/misc-check b/scripts/misc-check
> new file mode 100755
> index 000000000000..bf68712d1ac1
> --- /dev/null
> +++ b/scripts/misc-check
> @@ -0,0 +1,19 @@
> +#!/bin/sh
> +# SPDX-License-Identifier: GPL-2.0-only
> +
> +set -e
> +
> +# Detect files that are tracked but ignored by git. This is checked only when
> +# ${KBUILD_EXTRA_WARN} contains 1, git is installed, and the source tree is
> +# tracked by git.
> +check_tracked_ignored_files () {
> + case "${KBUILD_EXTRA_WARN}" in
> + *1*) ;;
> + *) return;;
> + esac
> +
> + git ls-files -i -c --exclude-per-directory=.gitignore 2>/dev/null |
> + sed 's/$/: warning: ignored by one of the .gitignore files/' >&2
> +}
> +
> +check_tracked_ignored_files
> --
> 2.34.1
>
On Sun 25 Dec 2022 00:51:38 GMT, Masahiro Yamada wrote:
> The top .gitignore comments about how to detect files breaking
> .gitignore rules, but people rarely care about it.
>
> Add a new W=1 warning to detect files that are tracked but ignored by
> git. If git is not installed or the source tree is not tracked by git
> at all, this script does not print anything.
>
> Running it on the v6.1 kernel detected the following:
>
> $ make W=1 misc-check
> Documentation/devicetree/bindings/.yamllint: warning: ignored by one of the .gitignore files
> drivers/clk/.kunitconfig: warning: ignored by one of the .gitignore files
> drivers/gpu/drm/tests/.kunitconfig: warning: ignored by one of the .gitignore files
> drivers/hid/.kunitconfig: warning: ignored by one of the .gitignore files
> fs/ext4/.kunitconfig: warning: ignored by one of the .gitignore files
> fs/fat/.kunitconfig: warning: ignored by one of the .gitignore files
> kernel/kcsan/.kunitconfig: warning: ignored by one of the .gitignore files
> lib/kunit/.kunitconfig: warning: ignored by one of the .gitignore files
> mm/kfence/.kunitconfig: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/.gitignore: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/Makefile: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/run_tags_test.sh: warning: ignored by one of the .gitignore files
> tools/testing/selftests/arm64/tags/tags_test.c: warning: ignored by one of the .gitignore files
>
> These are ignored by the '.*' or 'tags' in the top .gitignore, but
> there is no rule to negate it.
>
> You might be tempted to do 'git add -f' but I want to have the real
> issue fixed (by fixing a .gitignore, or by renaming files, etc.).
>
> Signed-off-by: Masahiro Yamada <[email protected]>
> ---
>
> Changes in v2:
> - Add $(srctree)/ to make it work with O=
>
> Makefile | 6 ++++++
> scripts/misc-check | 19 +++++++++++++++++++
> 2 files changed, 25 insertions(+)
> create mode 100755 scripts/misc-check
>
> diff --git a/Makefile b/Makefile
> index 44239352d2bf..f6ff8f77a669 100644
> --- a/Makefile
> +++ b/Makefile
> @@ -1852,6 +1852,12 @@ rust-analyzer:
> # Misc
> # ---------------------------------------------------------------------------
>
> +PHONY += misc-check
> +misc-check:
> + $(Q)$(srctree)/scripts/misc-check
> +
> +all: misc-check
> +
> PHONY += scripts_gdb
> scripts_gdb: prepare0
> $(Q)$(MAKE) $(build)=scripts/gdb
> diff --git a/scripts/misc-check b/scripts/misc-check
> new file mode 100755
> index 000000000000..bf68712d1ac1
> --- /dev/null
> +++ b/scripts/misc-check
> @@ -0,0 +1,19 @@
> +#!/bin/sh
> +# SPDX-License-Identifier: GPL-2.0-only
> +
> +set -e
> +
> +# Detect files that are tracked but ignored by git. This is checked only when
> +# ${KBUILD_EXTRA_WARN} contains 1, git is installed, and the source tree is
> +# tracked by git.
> +check_tracked_ignored_files () {
> + case "${KBUILD_EXTRA_WARN}" in
> + *1*) ;;
> + *) return;;
> + esac
> +
> + git ls-files -i -c --exclude-per-directory=.gitignore 2>/dev/null |
> + sed 's/$/: warning: ignored by one of the .gitignore files/' >&2
I like that check. It doesn't work with O=...; works for me with
something like:
git ${abs_srctree:+-C "${abs_srctree}"} ls-files ...
Reviewed-by: Nicolas Schier <[email protected]>
On Thu, Dec 29, 2022 at 1:48 AM Nicolas Schier <[email protected]> wrote:
>
> On Sun 25 Dec 2022 00:51:38 GMT, Masahiro Yamada wrote:
> > The top .gitignore comments about how to detect files breaking
> > .gitignore rules, but people rarely care about it.
> >
> > Add a new W=1 warning to detect files that are tracked but ignored by
> > git. If git is not installed or the source tree is not tracked by git
> > at all, this script does not print anything.
> >
> > Running it on the v6.1 kernel detected the following:
> >
> > $ make W=1 misc-check
> > Documentation/devicetree/bindings/.yamllint: warning: ignored by one of the .gitignore files
> > drivers/clk/.kunitconfig: warning: ignored by one of the .gitignore files
> > drivers/gpu/drm/tests/.kunitconfig: warning: ignored by one of the .gitignore files
> > drivers/hid/.kunitconfig: warning: ignored by one of the .gitignore files
> > fs/ext4/.kunitconfig: warning: ignored by one of the .gitignore files
> > fs/fat/.kunitconfig: warning: ignored by one of the .gitignore files
> > kernel/kcsan/.kunitconfig: warning: ignored by one of the .gitignore files
> > lib/kunit/.kunitconfig: warning: ignored by one of the .gitignore files
> > mm/kfence/.kunitconfig: warning: ignored by one of the .gitignore files
> > tools/testing/selftests/arm64/tags/.gitignore: warning: ignored by one of the .gitignore files
> > tools/testing/selftests/arm64/tags/Makefile: warning: ignored by one of the .gitignore files
> > tools/testing/selftests/arm64/tags/run_tags_test.sh: warning: ignored by one of the .gitignore files
> > tools/testing/selftests/arm64/tags/tags_test.c: warning: ignored by one of the .gitignore files
> >
> > These are ignored by the '.*' or 'tags' in the top .gitignore, but
> > there is no rule to negate it.
> >
> > You might be tempted to do 'git add -f' but I want to have the real
> > issue fixed (by fixing a .gitignore, or by renaming files, etc.).
> >
> > Signed-off-by: Masahiro Yamada <[email protected]>
> > ---
> >
> > Changes in v2:
> > - Add $(srctree)/ to make it work with O=
> >
> > Makefile | 6 ++++++
> > scripts/misc-check | 19 +++++++++++++++++++
> > 2 files changed, 25 insertions(+)
> > create mode 100755 scripts/misc-check
> >
> > diff --git a/Makefile b/Makefile
> > index 44239352d2bf..f6ff8f77a669 100644
> > --- a/Makefile
> > +++ b/Makefile
> > @@ -1852,6 +1852,12 @@ rust-analyzer:
> > # Misc
> > # ---------------------------------------------------------------------------
> >
> > +PHONY += misc-check
> > +misc-check:
> > + $(Q)$(srctree)/scripts/misc-check
> > +
> > +all: misc-check
> > +
> > PHONY += scripts_gdb
> > scripts_gdb: prepare0
> > $(Q)$(MAKE) $(build)=scripts/gdb
> > diff --git a/scripts/misc-check b/scripts/misc-check
> > new file mode 100755
> > index 000000000000..bf68712d1ac1
> > --- /dev/null
> > +++ b/scripts/misc-check
> > @@ -0,0 +1,19 @@
> > +#!/bin/sh
> > +# SPDX-License-Identifier: GPL-2.0-only
> > +
> > +set -e
> > +
> > +# Detect files that are tracked but ignored by git. This is checked only when
> > +# ${KBUILD_EXTRA_WARN} contains 1, git is installed, and the source tree is
> > +# tracked by git.
> > +check_tracked_ignored_files () {
> > + case "${KBUILD_EXTRA_WARN}" in
> > + *1*) ;;
> > + *) return;;
> > + esac
> > +
> > + git ls-files -i -c --exclude-per-directory=.gitignore 2>/dev/null |
> > + sed 's/$/: warning: ignored by one of the .gitignore files/' >&2
>
> I like that check. It doesn't work with O=...; works for me with
> something like:
>
> git ${abs_srctree:+-C "${abs_srctree}"} ls-files ...
A good catch!
I will fix it in v3.
Thanks.
>
> Reviewed-by: Nicolas Schier <[email protected]>
--
Best Regards
Masahiro Yamada