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

Enhance default build type selection #1229

Merged
merged 2 commits into from
Aug 27, 2024
Merged

Conversation

sandro-elsweijer
Copy link
Collaborator

Describe your changes here:
Currently, the default build type in ccmake is not shown and the cmake build type is empty from the start. If it remains empty, release is chosen. This PR changes that, so release is displayed from the start and cannot be left empty.
Furthermore the docstring now lists our available build types, before it was the standard message which also listed MinSizeRel, which is not available in our list.

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.

Licence

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

@sandro-elsweijer sandro-elsweijer added enhancement Enhances already existing code shouldn't take long Can be resolved in under 30 mins priority: low Should be solved eventually workload: low Would take half a day or less CMake Is about the CMake build system labels Aug 21, 2024
@Davknapp Davknapp self-assigned this Aug 26, 2024
@Davknapp Davknapp merged commit f182d58 into main Aug 27, 2024
22 checks passed
@Davknapp Davknapp deleted the enhancement-default_build_type branch August 27, 2024 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CMake Is about the CMake build system enhancement Enhances already existing code priority: low Should be solved eventually shouldn't take long Can be resolved in under 30 mins workload: low Would take half a day or less
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants