d/freebsd-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
186a372f24
freebsd-dev/.clang-format

199 lines
4.7 KiB
Plaintext
Raw Normal View History

Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
# $FreeBSD$
# Basic .clang-format
---
BasedOnStyle: WebKit
AlignAfterOpenBracket: DontAlign
AlignConsecutiveAssignments: false
AlignConsecutiveDeclarations: false
AlignEscapedNewlines: Left
AlignOperands: false
Set AlignTrailingComments in the clang-format config This seems to be fairly common in existing code and often looks better when adding trailing comments to e.g. enumerators or array initializers. See D26340 for more context. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D26391
2020-09-10 14:11:29 +00:00
AlignTrailingComments: true
clang-format: Avoid breaking after the opening paren of function definitions This depends on https://reviews.llvm.org/D90246 to have any effect, but once that has landed clang-format will no longer format code like this: ``` int myfunction( int param1, int param2, int param2) { ... } ``` and instead create the following: ``` int myfunction(int param1, int param2, int param2) { ... } ``` Reviewed By: emaste, cem Differential Revision: https://reviews.freebsd.org/D26978
2020-10-28 11:54:00 +00:00
AllowAllArgumentsOnNextLine: false
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
AllowAllParametersOfDeclarationOnNextLine: false
Use the correct config names for some .clang-format entries Those values are enum entries and should use "Never" instead of "false". clang-format currently accepts false, but it's better to use the correct syntax in case that changes in the future.
2020-09-10 14:11:24 +00:00
AllowShortBlocksOnASingleLine: Never
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: InlineOnly
Use the correct config names for some .clang-format entries Those values are enum entries and should use "Never" instead of "false". clang-format currently accepts false, but it's better to use the correct syntax in case that changes in the future.
2020-09-10 14:11:24 +00:00
AllowShortIfStatementsOnASingleLine: Never
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterReturnType: TopLevelDefinitions
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: MultiLine
BinPackArguments: true
BinPackParameters: true
BreakBeforeBinaryOperators: None
BreakBeforeBraces: WebKit
BreakBeforeTernaryOperators: false
# TODO: BreakStringLiterals can cause very strange formatting so turn it off?
BreakStringLiterals: false
clang-format: Avoid breaking after the opening paren of function definitions This depends on https://reviews.llvm.org/D90246 to have any effect, but once that has landed clang-format will no longer format code like this: ``` int myfunction( int param1, int param2, int param2) { ... } ``` and instead create the following: ``` int myfunction(int param1, int param2, int param2) { ... } ``` Reviewed By: emaste, cem Differential Revision: https://reviews.freebsd.org/D26978
2020-10-28 11:54:00 +00:00
# Prefer:
# some_var = function(arg1,
# arg2)
# over:
# some_var =
# function(arg1, arg2)
PenaltyBreakAssignment: 100
# Prefer:
# some_long_function(arg1, arg2
# arg3)
# over:
# some_long_function(
# arg1, arg2, arg3)
PenaltyBreakBeforeFirstCallParameter: 100
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
CompactNamespaces: true
DerivePointerAlignment: false
DisableFormat: false
ForEachMacros:
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- ARB_ARRFOREACH
- ARB_ARRFOREACH_REVWCOND
- ARB_ARRFOREACH_REVERSE
- ARB_FOREACH
- ARB_FOREACH_FROM
- ARB_FOREACH_SAFE
- ARB_FOREACH_REVERSE
- ARB_FOREACH_REVERSE_FROM
- ARB_FOREACH_REVERSE_SAFE
clang-format: Add bitset loop macros MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2021-09-21 15:39:49 +00:00
- BIT_FOREACH_ISCLR
- BIT_FOREACH_ISSET
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- CPU_FOREACH
clang-format: Add bitset loop macros MFC after: 2 weeks Sponsored by: The FreeBSD Foundation
2021-09-21 15:39:49 +00:00
- CPU_FOREACH_ISCLR
- CPU_FOREACH_ISSET
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- FOREACH_THREAD_IN_PROC
- FOREACH_PROC_IN_SYSTEM
- FOREACH_PRISON_CHILD
- FOREACH_PRISON_DESCENDANT
- FOREACH_PRISON_DESCENDANT_LOCKED
- FOREACH_PRISON_DESCENDANT_LOCKED_LEVEL
- MNT_VNODE_FOREACH_ALL
- MNT_VNODE_FOREACH_ACTIVE
- RB_FOREACH
- RB_FOREACH_FROM
- RB_FOREACH_SAFE
- RB_FOREACH_REVERSE
- RB_FOREACH_REVERSE_FROM
- RB_FOREACH_REVERSE_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- SLIST_FOREACH
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- SLIST_FOREACH_FROM
- SLIST_FOREACH_FROM_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- SLIST_FOREACH_SAFE
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- SLIST_FOREACH_PREVPTR
- SPLAY_FOREACH
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- LIST_FOREACH
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- LIST_FOREACH_FROM
- LIST_FOREACH_FROM_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- LIST_FOREACH_SAFE
- STAILQ_FOREACH
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- STAILQ_FOREACH_FROM
- STAILQ_FOREACH_FROM_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- STAILQ_FOREACH_SAFE
- TAILQ_FOREACH
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- TAILQ_FOREACH_FROM
- TAILQ_FOREACH_FROM_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- TAILQ_FOREACH_REVERSE
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- TAILQ_FOREACH_REVERSE_FROM
- TAILQ_FOREACH_REVERSE_FROM_SAFE
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
- TAILQ_FOREACH_REVERSE_SAFE
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
- TAILQ_FOREACH_SAFE
- VM_MAP_ENTRY_FOREACH
Move vm_page_dump bitset array definition to MI code These definitions were repeated by all architectures, with small variations. Consolidate the common definitons in machine independent code and use bitset(9) macros for manipulation. Many opportunities for deduplication remain in the machine dependent minidump logic. The only intended functional change is increasing the bit index type to vm_pindex_t, allowing the indexing of pages with address of 8 TiB and greater. Reviewed by: kib, markj Approved by: scottl (implicit) MFC after: 1 week Sponsored by: Ampere Computing, Inc. Differential Revision: https://reviews.freebsd.org/D26129
2020-09-21 22:20:37 +00:00
- VM_PAGE_DUMP_FOREACH
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
IndentCaseLabels: false
IndentPPDirectives: None
Language: Cpp
NamespaceIndentation: None
PointerAlignment: Right
ContinuationIndentWidth: 4
IndentWidth: 8
TabWidth: 8
ColumnLimit: 80
UseTab: Always
SpaceAfterCStyleCast: false
Update .clang-format with style(9) header-sorting Thanks to work done in the NetBSD clang-format project. No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25428
2020-06-24 18:40:43 +00:00
IncludeBlocks: Regroup
IncludeCategories:
- Regex: '^\"opt_.*\.h\"'
Priority: 1
SortPriority: 10
- Regex: '^<sys/cdefs\.h>'
Priority: 2
SortPriority: 20
- Regex: '^<sys/types\.h>'
Priority: 2
SortPriority: 21
- Regex: '^<sys/param\.h>'
Priority: 2
SortPriority: 22
clang-format: place sys/systm.h immediately after sys/param.h Should fix one of the objections to r366993. See also https://reviews.freebsd.org/D26981. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D26979
2020-10-28 11:53:55 +00:00
- Regex: '^<sys/systm\.h>'
Update .clang-format with style(9) header-sorting Thanks to work done in the NetBSD clang-format project. No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25428
2020-06-24 18:40:43 +00:00
Priority: 2
SortPriority: 23
clang-format: place sys/systm.h immediately after sys/param.h Should fix one of the objections to r366993. See also https://reviews.freebsd.org/D26981. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D26979
2020-10-28 11:53:55 +00:00
- Regex: '^<sys.*/'
Priority: 2
SortPriority: 24
Update .clang-format with style(9) header-sorting Thanks to work done in the NetBSD clang-format project. No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25428
2020-06-24 18:40:43 +00:00
- Regex: '^<vm/vm\.h>'
Priority: 3
SortPriority: 30
- Regex: '^<vm/'
Priority: 3
SortPriority: 31
- Regex: '^<machine/'
Priority: 4
SortPriority: 40
- Regex: '^<(x86|amd64|i386|xen)/'
Priority: 5
SortPriority: 50
- Regex: '^<dev/'
Priority: 6
SortPriority: 60
- Regex: '^<net.*/'
Priority: 7
SortPriority: 70
- Regex: '^<protocols/'
Priority: 7
SortPriority: 71
- Regex: '^<(fs|nfs(|client|server)|ufs)/'
Priority: 8
SortPriority: 80
- Regex: '^<[^/].*\.h'
Priority: 9
SortPriority: 90
- Regex: '^\".*\.h\"'
Priority: 10
SortPriority: 100
Clang-format: Avoid hardcoded LLVM include-order style Reported by: emaste
2020-06-24 23:22:36 +00:00
# LLVM's header include ordering style is almost the exact opposite of ours.
# Unfortunately, they have hard-coded their preferences into clang-format.
# Clobbering this regular expression to avoid matching prevents non-system
# headers from being forcibly moved to the top of the include list.
# http://llvm.org/docs/CodingStandards.html#include-style
IncludeIsMainRegex: 'BLAH_DONT_MATCH_ANYTHING'
Update .clang-format with style(9) header-sorting Thanks to work done in the NetBSD clang-format project. No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25428
2020-06-24 18:40:43 +00:00
SortIncludes: true
Add a basic clang-format configuration file This gets reasonably close to the existing format in sys/kern but will probably require some changes to upstream clang-format before it can be used as the default formatting tool. I tried formatting a few files in sys/kern and the result is pretty close to the existing code. However, this configuration file is not ready to be used without manually checking the output. Reviewed By: emaste Differential Revision: https://reviews.freebsd.org/D20533
2019-06-07 15:23:52 +00:00
KeepEmptyLinesAtTheStartOfBlocks: true
Update .clang-format type and foreach macros lists No functional change. Reviewed by: markj Differential Revision: https://reviews.freebsd.org/D25429
2020-06-24 22:42:46 +00:00
TypenameMacros:
- ARB_ELMTYPE
- ARB_HEAD
- ARB8_HEAD
- ARB16_HEAD
- ARB32_HEAD
- ARB_ENTRY
- ARB8_ENTRY
- ARB16_ENTRY
- ARB32_ENTRY
- LIST_CLASS_ENTRY
- LIST_CLASS_HEAD
- LIST_ENTRY
- LIST_HEAD
- QUEUE_TYPEOF
- RB_ENTRY
- RB_HEAD
- SLIST_CLASS_HEAD
- SLIST_CLASS_ENTRY
- SLIST_HEAD
- SLIST_ENTRY
- SMR_POINTER
- SPLAY_ENTRY
- SPLAY_HEAD
- STAILQ_CLASS_ENTRY
- STAILQ_CLASS_HEAD
- STAILQ_ENTRY
- STAILQ_HEAD
- TAILQ_CLASS_ENTRY
- TAILQ_CLASS_HEAD
- TAILQ_ENTRY
- TAILQ_HEAD
Reference in New Issue Copy Permalink