-
Notifications
You must be signed in to change notification settings - Fork 88
refactor(cmake): CMake configuration files for improved readability #904
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
Open
SYaoJun
wants to merge
2
commits into
apache:main
Choose a base branch
from
SYaoJun:0304_cmake_format
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| # Licensed to the Apache Software Foundation (ASF) under one | ||
| # or more contributor license agreements. See the NOTICE file | ||
| # distributed with this work for additional information | ||
| # regarding copyright ownership. The ASF licenses this file | ||
| # to you under the Apache License, Version 2.0 (the | ||
| # "License"); you may not use this file except in compliance | ||
| # with the License. You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, | ||
| # software distributed under the License is distributed on an | ||
| # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| # KIND, either express or implied. See the License for the | ||
| # specific language governing permissions and limitations | ||
| # under the License. | ||
|
|
||
| # cmake-format configuration file | ||
|
|
||
| # ----------------------------- | ||
| # Options affecting formatting. | ||
| # ----------------------------- | ||
| with section("format"): | ||
| # How wide to allow formatted cmake files | ||
| line_width = 90 | ||
|
|
||
| # How many spaces to tab for indent | ||
| tab_size = 2 | ||
|
|
||
| # If a positional argument group contains more than this many arguments, | ||
| # then force it to a vertical layout. | ||
| max_pargs_hwrap = 4 | ||
|
|
||
| # If the statement spelling length (including space and parenthesis) is | ||
| # smaller than this amount, then force reject nested layouts. | ||
| # This value only comes into play when considering whether or not to nest | ||
| # arguments below their parent. If the number of characters in the parent | ||
| # is less than this value, we will not nest. | ||
| min_prefix_chars = 32 | ||
|
|
||
| # If true, separate flow control names from their parentheses with a space | ||
| separate_ctrl_name_with_space = False | ||
|
|
||
| # If true, separate function names from parentheses with a space | ||
| separate_fn_name_with_space = False | ||
|
|
||
| # If a statement is wrapped to more than one line, than dangle the closing | ||
| # parenthesis on it's own line | ||
| dangle_parens = False | ||
|
|
||
| # What style line endings to use in the output. | ||
| line_ending = "unix" | ||
|
|
||
| # Format command names consistently as 'lower' or 'upper' case | ||
| command_case = "lower" | ||
|
|
||
| # Format keywords consistently as 'lower' or 'upper' case | ||
| keyword_case = "unchanged" | ||
|
|
||
| # ------------------------------------------------ | ||
| # Options affecting comment reflow and formatting. | ||
| # ------------------------------------------------ | ||
| with section("markup"): | ||
| # enable comment markup parsing and reflow | ||
| enable_markup = False | ||
|
|
||
| # If comment markup is enabled, don't reflow the first comment block in | ||
| # eachlistfile. Use this to preserve formatting of your | ||
| # copyright/licensestatements. | ||
| first_comment_is_literal = True | ||
|
|
||
| # If comment markup is enabled, don't reflow any comment block which | ||
| # matches this (regex) pattern. Default is `None` (disabled). | ||
| literal_comment_pattern = None |
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The cmake-format hook is added, but the repository config file is named
cmake-format.pyand isn't referenced here.cmake-formattypically auto-discovers.cmake-format.py/.cmake-format.yaml, so this setup may run with default formatting settings in CI and on contributors' machines. Rename the config to.cmake-format.pyor pass the config explicitly via hookargs(e.g.,--config-files cmake-format.py).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
cmake-format.py also can find it.