Skip to content

Conversation

@holke
Copy link
Collaborator

@holke holke commented May 28, 2025

Describe your changes here:

A slight overall of our indent scripts.

  1. Add a list of ignored files to our indent script.
    Since clang-format only supports ignore files from version 18 and we use version 17, some bash magic was required to manually parse the list of ignored files.

We should consider updating to clang-format >= 18.

  1. We had two scripts "t8indent" and "check_if_file_indented" that were nearly duplicates of each other.
    I cleaned this up by unifying the files such that "t8indent" is the only file with indentation code and has a new option "NO_CHANGE" and "check_if_file_indented" calls "t8indent" with that option.

Edit: I also fixed an unrelated typo in a comment in a t8_geometry file which kept the CI pipeline from failing. Usually i should have opened a new PR, but this was literally just one character and it was in a comment. So i thought i would get away with sneaking it into this PR to make the pipeline succeed.

Closes #1687
Preparation for #1675 and should be merged before #1522

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

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 CMake files.
  • The code is well documented. In particular, 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.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

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 or tutorial and a Wiki article.

License

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

@holke
Copy link
Collaborator Author

holke commented May 28, 2025

I just noticed that t8indent.sh and check_if_file_indented.sh are nearly identical and i either have to replicate code and put it into check_if_file_indented.sh or unify those files.
Will do the later - but no time for it now.

@codecov
Copy link

codecov bot commented May 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.02%. Comparing base (e6b165a) to head (77d538e).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1688   +/-   ##
=======================================
  Coverage   74.02%   74.02%           
=======================================
  Files          98       98           
  Lines       18577    18577           
=======================================
  Hits        13751    13751           
  Misses       4826     4826           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@holke
Copy link
Collaborator Author

holke commented May 28, 2025

Unified both scripts. However, there is still a bug since now all files are reported as indented by our pre-commit hook.

@holke holke marked this pull request as ready for review June 2, 2025 19:16
@holke holke added enhancement Enhances already existing code CI Continuous Integration labels Jun 2, 2025
@holke holke changed the title Improvement: indent ignore list [1/2] Improvement: indent ignore list and unification of indent scripts [1/2] Jun 2, 2025
Copy link
Collaborator

@lenaploetzke lenaploetzke left a comment

Choose a reason for hiding this comment

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

Nice changes! Just small comments



# Iterate over all arguments and throw
# aways those filenames that we should ignore.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
# aways those filenames that we should ignore.
# away those filenames that we should ignore.

WANTSOUT=1
fi
done
if [ -z "$WANTSOUT" ]; then
Copy link
Collaborator

Choose a reason for hiding this comment

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

A few more comments what is happening here for which options would be nice

# files instead of printing the changes to stdout. The --style=file
# arguments tells clang-format to look for a *.clang-format file.
FORMAT_OPTIONS="-i --style=file"
#
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe also state here that you can use the option -o ?

echo "Please install clang-format version $REQUIRED_VERSION_STRING"
exit 1
fi
usage="$0 [FILE_TO_INDENT]"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add USAGE: ?

@lenaploetzke lenaploetzke assigned holke and unassigned lenaploetzke Jun 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous Integration enhancement Enhances already existing code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

An ignore list for our indent script

3 participants