Add cmake-format, and a pre-commit hook for it #1755
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
run with command `git ls-files -- '*CMakeLists.txt' | xargs pre-commit run --files`
pratikvn
added
1:ST:do-not-merge
ginkgo-bot
added
reg:build
upsj
approved these changes
Dec 15, 2024
.cmake-format.json
Outdated
Comment on lines
8
to
19
| "foo": { | ||
| "flags": [ | ||
| "BAR", | ||
| "BAZ" | ||
| ], | ||
| "kwargs": { | ||
| "HEADERS": "*", | ||
| "SOURCES": "*", | ||
| "DEPENDS": "*" | ||
| } | ||
| } | ||
| }, |
There was a problem hiding this comment.
Here we should list the functions that use CMake argument parsing
There was a problem hiding this comment.
Here I meant mostly uses of cmake_parse_arguments, where the formatting tool can otherwise not differentiate between flags/kwargs and regular arguments
yhmtsai
requested changes
Dec 16, 2024
Comment on lines
+83
to
+87
| # \param name name for the executable to create (including type | ||
| # suffix) \param use_lib_linops Boolean indicating if linking against | ||
| # hipsparse/cusparse is necessary \param macro_def preprocessor macro name | ||
| # that will be defined during building (to compile for a specific type) All | ||
| # remaining arguments will be treated as source files |
| @@ -14,6 +14,12 @@ repos: | |||
| third_party/identify_stream_usage/.*| | |||
| include/ginkgo/ginkgo.hpp | |||
| ) | |||
| - repo: https://github.com/cheshirekow/cmake-format-precommit | |||
| rev: 'v0.6.13' # The current latest release | |||
There was a problem hiding this comment.
I think it is kind of uncontinued project
Comment on lines
+131
to
+133
| # \param name base-name for the executable to create \param | ||
| # use_lib_linops Boolean indicating if linking against hipsparse/cusparse is | ||
| # necessary All remaining arguments will be treated as source files |
Comment on lines
+7
to
+10
| # dashboard. The supported runs are: + With or without coverage, requires the | ||
| # gcov tool. + With or without address sanitizers. + With or without memory | ||
| # sanitizers. + With or without thread sanitizers. + With or without leak | ||
| # sanitizers. + With or without undefined behavior (UB) sanitizers. + With or |
| elseif((NOT CTEST_MEMORYCHECK_TYPE STREQUAL "NONE" AND NOT CTEST_MEMORYCHECK_TYPE STREQUAL "Valgrind") OR CTEST_BUILD_CONFIGURATION STREQUAL "COVERAGE") | ||
| set(GINKGO_CONFIGURE_OPTIONS "-DGINKGO_DEVEL_TOOLS=OFF;-DGINKGO_BUILD_REFERENCE=ON;-DGINKGO_BUILD_OMP=ON;-DGINKGO_BUILD_CUDA=OFF;-DGINKGO_BUILD_HIP=OFF;-DGINKGO_BUILD_SYCL=OFF;-DCMAKE_BUILD_TYPE=${CTEST_BUILD_CONFIGURATION}") | ||
| set(GINKGO_CONFIGURE_OPTIONS | ||
| "-DGINKGO_DEVEL_TOOLS=OFF;-DGINKGO_BUILD_REFERENCE=ON;-DGINKGO_BUILD_OMP=OFF;-DGINKGO_BUILD_CUDA=ON;-DGINKGO_BUILD_HIP=OFF;-DGINKGO_BUILD_SYCL=OFF;-DCMAKE_BUILD_TYPE=${CTEST_BUILD_CONFIGURATION};-DCMAKE_CUDA_FLAGS=-lineinfo" |
There was a problem hiding this comment.
it does not follow column limit
Comment on lines
+178
to
+180
| function(ginkgo_extract_dpcpp_version DPCPP_COMPILER GINKGO_DPCPP_VERSION | ||
| MACRO_VAR | ||
| ) |
Comment on lines
+202
to
+205
| set(${GINKGO_DPCPP_VERSION} | ||
| "${FOUND_DPCPP_VERSION}" | ||
| PARENT_SCOPE | ||
| ) |
Comment on lines
+149
to
+150
| STATUS | ||
| "Skipping ${_LANG}, not supported by build_type_helpers.cmake script" |
There was a problem hiding this comment.
after STATUS, it has one more indentation, but it does not do that after STRING in line 160
| @@ -17,102 +16,116 @@ set(GINKGO_INSTALL_MODULE_DIR "${CMAKE_INSTALL_LIBDIR}/cmake/Ginkgo/Modules") | |||
| # 3. GINKGO_INSTALL_RPATH_DEPENDENCIES : Allows adding any extra paths to the | |||
| # RPATH. | |||
| # | |||
| # @param name the name of the target | |||
| # @param ARGN any external dependencies path to be added | |||
| # @param name the name of the target @param ARGN any external dependencies | |||
| # We separate the library as a workaround to solve this issue | ||
| # To make ginkgo still be the major library, we make the original to ginkgo_core in MSVC/shared | ||
| # TODO: should think another way to solve it like dllexport or def file | ||
| # MSVC: LNK1189 issue CLANG in MSYS2 (MINGW): too many exported symbols We |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds a pre-commit hook to format CMakeLists,txt files. The actual format can still be discussed. But currently, I just formatted all CMakeLists.txt files with the default style. If necessary, we can adjust the style in the
.cmake-format.jsonfile.Unfortunately, as develop does not have cmake-format hook, the current format job will not run the cmake-format pre-commit hook yet.