AMReX-Astro / AMReX-Astro/Castro

add a header guard check to the clang CI

Open
#2,022 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

test coverage
Dominant language
C++
Stars
340
Forks
105
Avg merge
3d 8h
Merged PRs (30d)
8

Description

Clang 12.x supports -Wheader-guard that ensure that the header guard matches the define immediate after.

We caught one instance of a mismatch in Microphysics via ROCm. We should have the clang CI check this for us.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the repository's Clang CI configuration and checking how compiler warning flags are set. Enable the Clang 12.x header-guard warning there, then run the affected CI job or its local equivalent and confirm that mismatched header guards are detected.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.