Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ifdef t8 enable script #1375

Merged
merged 16 commits into from
Feb 20, 2025
Merged

Ifdef t8 enable script #1375

merged 16 commits into from
Feb 20, 2025

Conversation

Davknapp
Copy link
Collaborator

@Davknapp Davknapp commented Feb 4, 2025

Closes #1374

Checks in each file if a #ifdef T8_ENABLE_ is used instead of a #if T8_ENABLE_

All these boxes must be checked by the reviewers before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually

  • The code follows the t8code coding guidelines

  • New source/header files are properly added to the Makefiles

  • The code is well documented

  • All function declarations, structs/classes and their members have a proper doxygen documentation

  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue)

Tests

  • The code is covered in an existing or new test case using Google Test

Github action

  • The code compiles without warning in debugging and release mode, with and without MPI (this should be executed automatically in a github action)

  • All tests pass (in various configurations, this should be executed automatically in a github action)

    If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

    • Should this use case be added to the github action?
    • If not, does the specific use case compile and all tests pass (check manually)

Scripts and Wiki

  • If a new directory with source-files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one)

Tag Label

  • The author added the patch/minor/major label in accordance to semantic versioning.

Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great and awesome that you did it so quickly.
Some minor changes suggested.

@sandro-elsweijer
Copy link
Collaborator

sandro-elsweijer commented Feb 4, 2025

@Davknapp Can we also throw this in our spell checker CI?

@holke
Copy link
Collaborator

holke commented Feb 4, 2025

I propose to add this to our typos script so that it is executed by the CI.

@Davknapp Davknapp assigned holke and unassigned Davknapp Feb 4, 2025
@Davknapp
Copy link
Collaborator Author

Davknapp commented Feb 4, 2025

I propose to add this to our typos script so that it is executed by the CI.

That is not easily possible, because it it not really a typo and this is not what the intended use of the script is. Maybe we could hack it somehow, but I prefer @sandro-elsweijer suggestion.

@Davknapp
Copy link
Collaborator Author

Davknapp commented Feb 4, 2025

@Davknapp Can we also throw this in our spell checker CI?

sure

Copy link
Collaborator

@holke holke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice commenting :)
Only minor change left: the file name of the artifact.

@holke holke assigned Davknapp and unassigned holke Feb 19, 2025
@holke
Copy link
Collaborator

holke commented Feb 19, 2025

"If this PR introduces a new feature, it must be covered in an example/tutorial and a Wiki article."

We should adress this by documenting the usage of ENABLE_IF in our coding guidelines and linking to the new script.
If its not done yet, please do so or create an issue.

"The author added the patch/minor/major label in accordance to semantic versioning."
Please do so as well.

@Davknapp Davknapp added the patch-release Merging this needs a new patch tag label Feb 20, 2025
@Davknapp Davknapp assigned holke and unassigned Davknapp Feb 20, 2025
@holke holke added this pull request to the merge queue Feb 20, 2025
Merged via the queue into main with commit d24f60b Feb 20, 2025
20 checks passed
@holke holke deleted the ifdef-T8_ENABLE_script branch February 20, 2025 12:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
patch-release Merging this needs a new patch tag
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Catch "#ifdef T8_ENABLE_*" in files before commit
3 participants