[PATCH v5 0/6] meson: add corresponding target for Makefile's hdr-check

[Karthik Nayak <karthik.188@gmail.com>]

To bridge the remaining gaps between Makefile and Meson, this patch
series adds 'hdr-check' to Meson to compliment the Makefile's
'hdr-check'.

We also introduce 'headers-check' as an alias to 'hdr-check' as a better
named replacement in both Meson and make and add a note to deprecate
'hdr-check' in the future.

The first two commits are small cleanups, where we re-organize existing
variables to make it easier to add the target. The third commit adds the
'hdr-check' target to Meson. The last commit introduces the
'headers-check' alias to both Meson and the makefile and marks
'hdr-check' to be deprecated.

This is based on master 9d22ac5122 (The third batch, 2025-04-07) with
'es/meson-build-skip-coccinelle' merged in.

---
Changes in v5:
- Add a commit to install 'git' in GitHub's CI before the repository is
  checked out. Without the presence of the 'git' executable, GitHub
  downloads a tar of the repo instead of cloning it. This causes the
  patch series to fail in CI.
- Expose the 'headers_to_check' variable even if 'git' executable is not
  found or not a repository. This ensures dependencies of
  'headers_to_check' can simply rely on its length. We also check that
  the '.git' folder is setup before populating 'headers_to_check', this
  ensures Meson doesn't fail in tarball of the Git source code.
- Link to v4: https://lore.kernel.org/r/20250420-505-wire-up-sparse-via-meson-v4-0-66e14134e822@gmail.com

Changes in v4:
- Rename headers to headers_to_check, since these headers are only used
  for static analysis.
- Added a commit to rename third_party_sources -> third_party_excludes
  and remove a duplicate.
- Fix a typo 'gcrpyt' -> 'gcrypt'
- Remove 'generated_headers', since we use 'git ls-files' and that would
  already ignore files within '.gitignore'.
- Link to v3: https://lore.kernel.org/r/20250414-505-wire-up-sparse-via-meson-v3-0-edc6e7f26745@gmail.com

Changes in v3:
- Some renames:
  - headers_generated -> generated_headers
  - meson -> Meson
  - headers-check -> check-headers
  - headers_check_exclude -> exclude_from_check_headers
- Rewrite 'headers_check_exclude' to also contain dirs so we can skip
  listing individual header files.
- Move 'xdiff/*' to 'third_party_sources' and cleanup
  'exclude_from_check_headers'.
- Use 'echo' instead of 'echo -n'.
- Use `fs.replace_suffix` instead of `str.replace`.
- Link to v2: https://lore.kernel.org/r/20250410-505-wire-up-sparse-via-meson-v2-0-acb45cc8a2e5@gmail.com

Changes in v2:
- Add 'hdr-check' to meson, while introducing 'headers-check' as
  a replacement alias. Schedule 'hdr-check' to be deprecated in the future.
- Link to v1: https://lore.kernel.org/r/20250408-505-wire-up-sparse-via-meson-v1-0-17476e5cea3f@gmail.com

---
 .github/workflows/main.yml     | 14 +++++++
 Makefile                       |  4 +-
 ci/run-static-analysis.sh      |  2 +-
 contrib/coccinelle/meson.build | 31 ++++-----------
 meson.build                    | 86 ++++++++++++++++++++++++++++++++++++++++++
 5 files changed, 112 insertions(+), 25 deletions(-)

Karthik Nayak (6):
      ci/github: install git before checking out the repository
      coccinelle: meson: rename variables to be more specific
      meson: move headers definition from 'contrib/coccinelle'
      meson: rename 'third_party_sources' to 'third_party_excludes'
      meson: add support for 'hdr-check'
      makefile/meson: add 'check-headers' as alias for 'hdr-check'

Range-diff versus v4:

-:  ---------- > 1:  d20993a59e ci/github: install git before checking out the repository
1:  0f1160fa78 = 2:  6eb10dd3b1 coccinelle: meson: rename variables to be more specific
2:  933b199def ! 3:  7950b44c6f meson: move headers definition from 'contrib/coccinelle'
    @@ Commit message
         makes it easier to understand as the variable is now propagated from the
         top level to the bottom.
     
    +    While 'headers_to_check' is only computed when we have a repository and
    +    the 'git' executable is present, the variable itself is exposed as an
    +    empty array. This allows dependencies in upcoming commits to simply
    +    check for length of the array and not worry about dependencies required
    +    to actually populate the array.
    +
         Signed-off-by: Karthik Nayak <karthik.188@gmail.com>
     
      ## contrib/coccinelle/meson.build ##
    @@ meson.build: builtin_sources = [
     +  ':!t/t[0-9][0-9][0-9][0-9]*',
     +]
     +
    -+if git.found()
    -+  headers_to_check = []
    ++headers_to_check = []
    ++if git.found() and fs.exists(meson.project_source_root() / '.git')
     +  foreach header : run_command(git, '-C', meson.project_source_root(), 'ls-files', '--deduplicate', '*.h', third_party_sources, check: true).stdout().split()
     +    headers_to_check += header
     +  endforeach
3:  ab04192864 ! 4:  7fd64b788b meson: rename 'third_party_sources' to 'third_party_excludes'
    @@ meson.build: third_party_sources = [
        ':!t/t[0-9][0-9][0-9][0-9]*',
      ]
      
    - if git.found()
    -   headers_to_check = []
    + headers_to_check = []
    + if git.found() and fs.exists(meson.project_source_root() / '.git')
     -  foreach header : run_command(git, '-C', meson.project_source_root(), 'ls-files', '--deduplicate', '*.h', third_party_sources, check: true).stdout().split()
     +  foreach header : run_command(git, '-C', meson.project_source_root(), 'ls-files', '--deduplicate', '*.h', third_party_excludes, check: true).stdout().split()
          headers_to_check += header
4:  69a4b5abc9 ! 5:  df0472be57 meson: add support for 'hdr-check'
    @@ meson.build: third_party_excludes = [
     +  ':!xdiff',
      ]
      
    - if git.found()
    + headers_to_check = []
     @@ meson.build: endif
      
      subdir('contrib')
    @@ meson.build: endif
     +  exclude_from_check_headers += 'sha256/gcrypt.h'
     +endif
     +
    -+if git.found() and compiler.get_argument_syntax() == 'gcc'
    ++if headers_to_check.length() != 0 and compiler.get_argument_syntax() == 'gcc'
     +  hco_targets = []
     +  foreach h : headers_to_check
     +    skip_header = false
5:  a0c799cf8c ! 6:  7d9a33767b makefile/meson: add 'check-headers' as alias for 'hdr-check'
    @@ ci/run-static-analysis.sh: then
      make check-pot
     
      ## meson.build ##
    -@@ meson.build: if git.found() and compiler.get_argument_syntax() == 'gcc'
    +@@ meson.build: if headers_to_check.length() != 0 and compiler.get_argument_syntax() == 'gcc'
          hco_targets += hco
        endforeach
      


base-commit: 3a956c5f69873611ae5f8dcb9acd117f66b95ddc
change-id: 20250330-505-wire-up-sparse-via-meson-2e32dd31208b

Thanks
- Karthik