Skip to contentSkip to conversation

.gitignore: update the command to check tracked files being ignored

PATCH In review Masahiro Yamada 3 participants 9 messages Dec 29, 2022 – Jan 27, 2023 Kbuild

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/2 .gitignore: update the command to check tracked files being ignored

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 before, but we need to make it explicit since git commit b338e9f66873 ("ls-files: error out on -i unless -o or -c are specified").

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 cannot predict what is locally added to .git/info/exclude or the user's global exclusion file.

We can only manage .gitignore files committed to the repository.

---

Changes in v3:
- Fix a typo. Update commit description per Miguel

 .gitignore | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
.gitignore +1 -1
index 3ec73ead6757..2e2e3d1eeaee 100644
@@ -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.
 #
Signature · 1 line
2.34.1
#1 lore raw

PATCH v3 2/2 kbuild: make W=1 warn files that are tracked but ignored by git

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 v6.2-rc1 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.).

---

Changes in v3:
- change working directory to srctree (Nicolas)

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
Makefile +6 -0
index acce5ec514f6..c0d7c75d8f14 100644
@@ -1848,6 +1848,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
scripts/misc-check new file +19 -0
new file mode 100755
index 000000000000..d40d5484e0c5
@@ -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 -C ${srctree:-.} 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
Signature · 1 line
2.34.1
Tested-by on v3 2/2
#2 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 38 lines · On Thu, Dec 29, 2022 at 04:43:10PM +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 v6.2-rc1 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.).

---

Changes in v3:
- change working directory to srctree (Nicolas)

Quoted 7 lines

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

out of curiosity: do you plan to implement more checks in the misc-checks target?

Kind regards,
Nicolas

#3 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 48 lines · Nicolas Schier
Quoted 38 lines · On Thu, Dec 29, 2022 at 04:43:10PM +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 v6.2-rc1 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.).

---

Changes in v3:
- change working directory to srctree (Nicolas)

Quoted 7 lines

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
Quoted 4 lines

out of curiosity: do you plan to implement more checks in the misc-checks target?

I chose a generic name so I can put more in this script, but honestly I have nothing else in my mind for now.

Quoted 4 lines

Kind regards,
Nicolas

Signature · 2 lines
Best Regards
Masahiro Yamada
#4 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

In reply to Masahiro Yamada
Quoted 8 lines · Masahiro Yamada

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 v6.2-rc1 detected the following:

Since patch was published there is no sign it was ever meet Linux Next. What's the plan?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#5 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 5 lines · Andy Shevchenko
Quoted 3 lines · Masahiro Yamada

The top .gitignore comments about how to detect files breaking .gitignore rules, but people rarely care about it.

Quoted 8 lines
Quoted 5 lines

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 v6.2-rc1 detected the following:

Since patch was published there is no sign it was ever meet Linux Next. What's the plan?

Oh?
I can see this patch in linux-next.

$ git log next-20230127 -- scripts/misc-check
Signature · 2 lines
Best Regards
Masahiro Yamada
#6 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 11 lines · Masahiro Yamada
Quoted 9 lines · Andy Shevchenko
Quoted 7 lines · Masahiro Yamada

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.

Quoted 6 lines
Quoted 4 lines
Quoted 1 line

Running it on v6.2-rc1 detected the following:

Since patch was published there is no sign it was ever meet Linux Next. What's the plan?

Oh?

Sorry, my mistake. I need to understand why these patches do not fix the issue I have.

Quoted 3 lines

I can see this patch in linux-next.

$ git log next-20230127 -- scripts/misc-check
Signature · 2 lines
With Best Regards,
Andy Shevchenko
#7 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 14 lines · Andy Shevchenko
Quoted 13 lines · Masahiro Yamada
Quoted 11 lines · Andy Shevchenko
Quoted 8 lines · Masahiro Yamada

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 v6.2-rc1 detected the following:

Quoted 7 lines
Quoted 4 lines
Quoted 2 lines

Since patch was published there is no sign it was ever meet Linux Next. What's the plan?

Oh?

Sorry, my mistake. I need to understand why these patches do not fix the issue I have.

OK, after carefully reading the commit message it's actually the culprit of the warnings I have.

So, it seems we need to wait maintainers / developers of the respective code to go and fix this. Is it your intention?

Signature · 2 lines
With Best Regards,
Andy Shevchenko
#8 lore raw

Re: [PATCH v3 2/2] kbuild: make W=1 warn files that are tracked but ignored by git

Quoted 21 lines · Andy Shevchenko
Quoted 19 lines · Andy Shevchenko
Quoted 17 lines · Masahiro Yamada
Quoted 5 lines · Andy Shevchenko
Quoted 3 lines · Masahiro Yamada

The top .gitignore comments about how to detect files breaking .gitignore rules, but people rarely care about it.

Quoted 8 lines
Quoted 5 lines

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 v6.2-rc1 detected the following:

Since patch was published there is no sign it was ever meet Linux Next. What's the plan?

Oh?

Quoted 8 lines
Quoted 2 lines

Sorry, my mistake. I need to understand why these patches do not fix the issue I have.

OK, after carefully reading the commit message it's actually the culprit of the warnings I have.

So, it seems we need to wait maintainers / developers of the respective code to go and fix this. Is it your intention?

Yes.
I expect the 0day bot will block new breakages,
but actually the mainline got more warnings
under kselftest.

Signature · 2 lines
Best Regards
Masahiro Yamada