Improvement: T8_WITH_ macros that will throw an error when used #1522
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes here:
I put this up for discussion.
Since #1468 all our macros have been renamed from T8_WITH* to T8_ENABLE*.
We have an internal check_macros script to find all wrongly used T8_WITH in our code base.
However, user code may not be aware of the changes and still use code like
This code will still compile after the update and if users do not read and implement the update news, they will run into behaviour that is
a) undesired and
b) very hard to track down
I propose a solution that overwrites the old T8_WITH_ macros so that using them with "#if" will throw a compile time error.
Thus, users will be immediately warned and informed to use T8_ENABLE instead.
The following points are still open:
Even when using "// clang-format off" comments. Hence, we must somehow make the automatic indent script ignore this file.
All these boxes must be checked by the AUTHOR before requesting review:
Documentation:
,Bugfix:
,Feature:
,Improvement:
orOther:
.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
Tests
If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):
Scripts and Wiki
script/find_all_source_files.scp
to check the indentation of these files.License
doc/
(or already has one).