scripts/setlocalversion: add more comments to -dirty flag detection
authorMasahiro Yamada <masahiroy@kernel.org>
Sun, 23 May 2021 03:14:26 +0000 (12:14 +0900)
committerMasahiro Yamada <masahiroy@kernel.org>
Wed, 26 May 2021 19:01:51 +0000 (04:01 +0900)
commitffaf62a8050b5f7995083ee93526b57d8d79fec4
tree0808e5154d57f9474ba9401283f308eb160b8b38
parenta2be76a352f1035a2e5f914a409743d65dc514c5
scripts/setlocalversion: add more comments to -dirty flag detection

This script stumbled on the read-only source tree over again:

 - a2bb90a08cb3 ("kbuild: fix delay in setlocalversion on readonly
   source")

 - cdf2bc632ebc ("scripts/setlocalversion on write-protected source
   tree")

 - 8ef14c2c41d9 ("Revert "scripts/setlocalversion: git: Make -dirty
   check more robust"")

 - ff64dd485730 ("scripts/setlocalversion: Improve -dirty check with
   git-status --no-optional-locks")

Add comments to clarify that this script should never ever try to write
to the source tree.

'git describe --dirty' might look as a simple solution for appending
the -dirty string, but we cannot use it because it creates the
.git/index.lock file.

Signed-off-by: Masahiro Yamada <masahiroy@kernel.org>
Reviewed-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Reviewed-by: Nico Schottelius <nico-linuxsetlocalversion@schottelius.org>
scripts/setlocalversion