linux-kernel - Re: [PATCH] .gitignore: ignore temporary files from 'bear'

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <20250829233824.GB1983886@ax162>
Date: Fri, 29 Aug 2025 16:38:24 -0700
From: Nathan Chancellor <nathan@...nel.org>
To: Brendan Jackman <jackmanb@...gle.com>
Cc: Nick Desaulniers <nick.desaulniers+lkml@...il.com>,
	Bill Wendling <morbo@...gle.com>, linux-kernel@...r.kernel.org,
	Justin Stitt <justinstitt@...gle.com>, llvm@...ts.linux.dev,
	linux-kbuild@...r.kernel.org, Nicolas Schier <nsc@...nel.org>
Subject: Re: [PATCH] .gitignore: ignore temporary files from 'bear'

Hi Brendan,

On Wed, Aug 27, 2025 at 08:59:43AM +0000, Brendan Jackman wrote:
> Bear [0] is a tool for generating compile_commands.json. For Kbuild,
> Bear is not useful, since Kbuild already generates the necessary info
> and that can be converted to compile_commands.json by
> gen_compile_commads.py.
> 
> However, for code in tools/, it's handy. For example, this command
> updates compile_commands.json so that clangd code navigation will also
> work for the VMA unit tests:
> 
> 	bear --append -- make -C tools/testing/vma -j
> 
> Bear generates some temporary files. These are usually deleted again
> but having them show up ephemerally confuses tools that trigger
> recompilation on source code changes. Ignore them in Git so that these
> tools can tell they aren't source code.
> 
> [0]: https://github.com/rizsotto/Bear
> 
> Signed-off-by: Brendan Jackman <jackmanb@...gle.com>

We can likely take this via the Kbuild tree. I do wonder if this would
be better in a tools/.gitignore file since bear is really only of use
there but I am not sure it matters much.

> ---
>  .gitignore | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/.gitignore b/.gitignore
> index 929054df5212d68a32a1f5ee2b267389fcd1c8db..b07c8c8383bd791e903ce985c14c231cb6928411 100644
> --- a/.gitignore
> +++ b/.gitignore
> @@ -53,6 +53,7 @@
>  *.tar
>  *.xz
>  *.zst
> +*.tmp

Please keep the globs alphabetized.

>  Module.symvers
>  dtbs-list
>  modules.order
> @@ -177,6 +178,9 @@ x509.genkey
>  
>  # Clang's compilation database file
>  /compile_commands.json
> +# Temporary files created by 'bear', a tool used for generating
> +# compile_commands.json for non-Kbuild code.
> +*.events.json

Please rebase this on kbuild-next, as '/' is no longer present in the
compile_commands.json line:

https://git.kernel.org/kbuild/l/kbuild-next

The comment feels a little lengthy compared to the rest of the file but
I am not sure it can really be slimmed down...

I am guessing the pattern cannot be made more specific, as I do wonder
if anyone would introduce files with this pattern but that is why we
have the check in scripts/misc-check, so it is probably not that big of
a deal.

>  
>  # Documentation toolchain
>  sphinx_*/
> 
> ---
> base-commit: fab1beda7597fac1cecc01707d55eadb6bbe773c
> change-id: 20250827-master-23458abb102d
> 
> Best regards,
> -- 
> Brendan Jackman <jackmanb@...gle.com>
> 
>