Fossil SCM

fossil-scm / compat / zlib / .cmake-format.yaml
Source Blame History 245 lines
6ea30fb… florian 1 _help_parse: Options affecting listfile parsing
6ea30fb… florian 2 parse:
6ea30fb… florian 3 _help_additional_commands:
6ea30fb… florian 4 - Specify structure for custom cmake functions
6ea30fb… florian 5 additional_commands:
6ea30fb… florian 6 foo:
6ea30fb… florian 7 flags:
6ea30fb… florian 8 - BAR
6ea30fb… florian 9 - BAZ
6ea30fb… florian 10 kwargs:
6ea30fb… florian 11 HEADERS: '*'
6ea30fb… florian 12 SOURCES: '*'
6ea30fb… florian 13 DEPENDS: '*'
6ea30fb… florian 14 _help_override_spec:
6ea30fb… florian 15 - Override configurations per-command where available
6ea30fb… florian 16 override_spec: {}
6ea30fb… florian 17 _help_vartags:
6ea30fb… florian 18 - Specify variable tags.
6ea30fb… florian 19 vartags: []
6ea30fb… florian 20 _help_proptags:
6ea30fb… florian 21 - Specify property tags.
6ea30fb… florian 22 proptags: []
6ea30fb… florian 23 _help_format: Options affecting formatting.
6ea30fb… florian 24 format:
6ea30fb… florian 25 _help_disable:
6ea30fb… florian 26 - Disable formatting entirely, making cmake-format a no-op
6ea30fb… florian 27 disable: false
6ea30fb… florian 28 _help_line_width:
6ea30fb… florian 29 - How wide to allow formatted cmake files
6ea30fb… florian 30 line_width: 80
6ea30fb… florian 31 _help_tab_size:
6ea30fb… florian 32 - How many spaces to tab for indent
6ea30fb… florian 33 tab_size: 4
6ea30fb… florian 34 _help_use_tabchars:
6ea30fb… florian 35 - If true, lines are indented using tab characters (utf-8
6ea30fb… florian 36 - 0x09) instead of <tab_size> space characters (utf-8 0x20).
6ea30fb… florian 37 - In cases where the layout would require a fractional tab
6ea30fb… florian 38 - character, the behavior of the fractional indentation is
6ea30fb… florian 39 - governed by <fractional_tab_policy>
6ea30fb… florian 40 use_tabchars: false
6ea30fb… florian 41 _help_fractional_tab_policy:
6ea30fb… florian 42 - If <use_tabchars> is True, then the value of this variable
6ea30fb… florian 43 - indicates how fractional indentions are handled during
6ea30fb… florian 44 - whitespace replacement. If set to 'use-space', fractional
6ea30fb… florian 45 - indentation is left as spaces (utf-8 0x20). If set to
6ea30fb… florian 46 - '`round-up` fractional indentation is replaced with a single'
6ea30fb… florian 47 - tab character (utf-8 0x09) effectively shifting the column
6ea30fb… florian 48 - to the next tabstop
6ea30fb… florian 49 fractional_tab_policy: use-space
6ea30fb… florian 50 _help_max_subgroups_hwrap:
6ea30fb… florian 51 - If an argument group contains more than this many sub-groups
6ea30fb… florian 52 - (parg or kwarg groups) then force it to a vertical layout.
6ea30fb… florian 53 max_subgroups_hwrap: 2
6ea30fb… florian 54 _help_max_pargs_hwrap:
6ea30fb… florian 55 - If a positional argument group contains more than this many
6ea30fb… florian 56 - arguments, then force it to a vertical layout.
6ea30fb… florian 57 max_pargs_hwrap: 6
6ea30fb… florian 58 _help_max_rows_cmdline:
6ea30fb… florian 59 - If a cmdline positional group consumes more than this many
6ea30fb… florian 60 - lines without nesting, then invalidate the layout (and nest)
6ea30fb… florian 61 max_rows_cmdline: 2
6ea30fb… florian 62 _help_separate_ctrl_name_with_space:
6ea30fb… florian 63 - If true, separate flow control names from their parentheses
6ea30fb… florian 64 - with a space
6ea30fb… florian 65 separate_ctrl_name_with_space: false
6ea30fb… florian 66 _help_separate_fn_name_with_space:
6ea30fb… florian 67 - If true, separate function names from parentheses with a
6ea30fb… florian 68 - space
6ea30fb… florian 69 separate_fn_name_with_space: false
6ea30fb… florian 70 _help_dangle_parens:
6ea30fb… florian 71 - If a statement is wrapped to more than one line, than dangle
6ea30fb… florian 72 - the closing parenthesis on its own line.
6ea30fb… florian 73 dangle_parens: false
6ea30fb… florian 74 _help_dangle_align:
6ea30fb… florian 75 - If the trailing parenthesis must be 'dangled' on its on
6ea30fb… florian 76 - 'line, then align it to this reference: `prefix`: the start'
6ea30fb… florian 77 - 'of the statement, `prefix-indent`: the start of the'
6ea30fb… florian 78 - 'statement, plus one indentation level, `child`: align to'
6ea30fb… florian 79 - the column of the arguments
6ea30fb… florian 80 dangle_align: prefix
6ea30fb… florian 81 _help_min_prefix_chars:
6ea30fb… florian 82 - If the statement spelling length (including space and
6ea30fb… florian 83 - parenthesis) is smaller than this amount, then force reject
6ea30fb… florian 84 - nested layouts.
6ea30fb… florian 85 min_prefix_chars: 4
6ea30fb… florian 86 _help_max_prefix_chars:
6ea30fb… florian 87 - If the statement spelling length (including space and
6ea30fb… florian 88 - parenthesis) is larger than the tab width by more than this
6ea30fb… florian 89 - amount, then force reject un-nested layouts.
6ea30fb… florian 90 max_prefix_chars: 10
6ea30fb… florian 91 _help_max_lines_hwrap:
6ea30fb… florian 92 - If a candidate layout is wrapped horizontally but it exceeds
6ea30fb… florian 93 - this many lines, then reject the layout.
6ea30fb… florian 94 max_lines_hwrap: 2
6ea30fb… florian 95 _help_line_ending:
6ea30fb… florian 96 - What style line endings to use in the output.
6ea30fb… florian 97 line_ending: unix
6ea30fb… florian 98 _help_command_case:
6ea30fb… florian 99 - Format command names consistently as 'lower' or 'upper' case
6ea30fb… florian 100 command_case: canonical
6ea30fb… florian 101 _help_keyword_case:
6ea30fb… florian 102 - Format keywords consistently as 'lower' or 'upper' case
6ea30fb… florian 103 keyword_case: unchanged
6ea30fb… florian 104 _help_always_wrap:
6ea30fb… florian 105 - A list of command names which should always be wrapped
6ea30fb… florian 106 always_wrap: []
6ea30fb… florian 107 _help_enable_sort:
6ea30fb… florian 108 - If true, the argument lists which are known to be sortable
6ea30fb… florian 109 - will be sorted lexicographicall
6ea30fb… florian 110 enable_sort: true
6ea30fb… florian 111 _help_autosort:
6ea30fb… florian 112 - If true, the parsers may infer whether or not an argument
6ea30fb… florian 113 - list is sortable (without annotation).
6ea30fb… florian 114 autosort: false
6ea30fb… florian 115 _help_require_valid_layout:
6ea30fb… florian 116 - By default, if cmake-format cannot successfully fit
6ea30fb… florian 117 - everything into the desired linewidth it will apply the
6ea30fb… florian 118 - last, most aggressive attempt that it made. If this flag is
6ea30fb… florian 119 - True, however, cmake-format will print error, exit with non-
6ea30fb… florian 120 - zero status code, and write-out nothing
6ea30fb… florian 121 require_valid_layout: false
6ea30fb… florian 122 _help_layout_passes:
6ea30fb… florian 123 - A dictionary mapping layout nodes to a list of wrap
6ea30fb… florian 124 - decisions. See the documentation for more information.
6ea30fb… florian 125 layout_passes: {}
6ea30fb… florian 126 _help_markup: Options affecting comment reflow and formatting.
6ea30fb… florian 127 markup:
6ea30fb… florian 128 _help_bullet_char:
6ea30fb… florian 129 - What character to use for bulleted lists
6ea30fb… florian 130 bullet_char: '*'
6ea30fb… florian 131 _help_enum_char:
6ea30fb… florian 132 - What character to use as punctuation after numerals in an
6ea30fb… florian 133 - enumerated list
6ea30fb… florian 134 enum_char: .
6ea30fb… florian 135 _help_first_comment_is_literal:
6ea30fb… florian 136 - If comment markup is enabled, don't reflow the first comment
6ea30fb… florian 137 - block in each listfile. Use this to preserve formatting of
6ea30fb… florian 138 - your copyright/license statements.
6ea30fb… florian 139 first_comment_is_literal: false
6ea30fb… florian 140 _help_literal_comment_pattern:
6ea30fb… florian 141 - If comment markup is enabled, don't reflow any comment block
6ea30fb… florian 142 - which matches this (regex) pattern. Default is `None`
6ea30fb… florian 143 - (disabled).
6ea30fb… florian 144 literal_comment_pattern: null
6ea30fb… florian 145 _help_fence_pattern:
6ea30fb… florian 146 - Regular expression to match preformat fences in comments
6ea30fb… florian 147 - default= ``r'^\s*([`~]{3}[`~]*)(.*)$'``
6ea30fb… florian 148 fence_pattern: ^\s*([`~]{3}[`~]*)(.*)$
6ea30fb… florian 149 _help_ruler_pattern:
6ea30fb… florian 150 - Regular expression to match rulers in comments default=
6ea30fb… florian 151 - '``r''^\s*[^\w\s]{3}.*[^\w\s]{3}$''``'
6ea30fb… florian 152 ruler_pattern: ^\s*[^\w\s]{3}.*[^\w\s]{3}$
6ea30fb… florian 153 _help_explicit_trailing_pattern:
6ea30fb… florian 154 - If a comment line matches starts with this pattern then it
6ea30fb… florian 155 - is explicitly a trailing comment for the preceding argument.
6ea30fb… florian 156 - Default is '#<'
6ea30fb… florian 157 explicit_trailing_pattern: '#<'
6ea30fb… florian 158 _help_hashruler_min_length:
6ea30fb… florian 159 - If a comment line starts with at least this many consecutive
6ea30fb… florian 160 - hash characters, then don't lstrip() them off. This allows
6ea30fb… florian 161 - for lazy hash rulers where the first hash char is not
6ea30fb… florian 162 - separated by space
6ea30fb… florian 163 hashruler_min_length: 10
6ea30fb… florian 164 _help_canonicalize_hashrulers:
6ea30fb… florian 165 - If true, then insert a space between the first hash char and
6ea30fb… florian 166 - remaining hash chars in a hash ruler, and normalize its
6ea30fb… florian 167 - length to fill the column
6ea30fb… florian 168 canonicalize_hashrulers: true
6ea30fb… florian 169 _help_enable_markup:
6ea30fb… florian 170 - enable comment markup parsing and reflow
6ea30fb… florian 171 enable_markup: true
6ea30fb… florian 172 _help_lint: Options affecting the linter
6ea30fb… florian 173 lint:
6ea30fb… florian 174 _help_disabled_codes:
6ea30fb… florian 175 - a list of lint codes to disable
6ea30fb… florian 176 disabled_codes: []
6ea30fb… florian 177 _help_function_pattern:
6ea30fb… florian 178 - regular expression pattern describing valid function names
6ea30fb… florian 179 function_pattern: '[0-9a-z_]+'
6ea30fb… florian 180 _help_macro_pattern:
6ea30fb… florian 181 - regular expression pattern describing valid macro names
6ea30fb… florian 182 macro_pattern: '[0-9A-Z_]+'
6ea30fb… florian 183 _help_global_var_pattern:
6ea30fb… florian 184 - regular expression pattern describing valid names for
6ea30fb… florian 185 - variables with global (cache) scope
6ea30fb… florian 186 global_var_pattern: '[A-Z][0-9A-Z_]+'
6ea30fb… florian 187 _help_internal_var_pattern:
6ea30fb… florian 188 - regular expression pattern describing valid names for
6ea30fb… florian 189 - variables with global scope (but internal semantic)
6ea30fb… florian 190 internal_var_pattern: _[A-Z][0-9A-Z_]+
6ea30fb… florian 191 _help_local_var_pattern:
6ea30fb… florian 192 - regular expression pattern describing valid names for
6ea30fb… florian 193 - variables with local scope
6ea30fb… florian 194 local_var_pattern: '[a-z][a-z0-9_]+'
6ea30fb… florian 195 _help_private_var_pattern:
6ea30fb… florian 196 - regular expression pattern describing valid names for
6ea30fb… florian 197 - privatedirectory variables
6ea30fb… florian 198 private_var_pattern: _[0-9a-z_]+
6ea30fb… florian 199 _help_public_var_pattern:
6ea30fb… florian 200 - regular expression pattern describing valid names for public
6ea30fb… florian 201 - directory variables
6ea30fb… florian 202 public_var_pattern: '[A-Z][0-9A-Z_]+'
6ea30fb… florian 203 _help_argument_var_pattern:
6ea30fb… florian 204 - regular expression pattern describing valid names for
6ea30fb… florian 205 - function/macro arguments and loop variables.
6ea30fb… florian 206 argument_var_pattern: '[a-z][a-z0-9_]+'
6ea30fb… florian 207 _help_keyword_pattern:
6ea30fb… florian 208 - regular expression pattern describing valid names for
6ea30fb… florian 209 - keywords used in functions or macros
6ea30fb… florian 210 keyword_pattern: '[A-Z][0-9A-Z_]+'
6ea30fb… florian 211 _help_max_conditionals_custom_parser:
6ea30fb… florian 212 - In the heuristic for C0201, how many conditionals to match
6ea30fb… florian 213 - within a loop in before considering the loop a parser.
6ea30fb… florian 214 max_conditionals_custom_parser: 2
6ea30fb… florian 215 _help_min_statement_spacing:
6ea30fb… florian 216 - Require at least this many newlines between statements
6ea30fb… florian 217 min_statement_spacing: 1
6ea30fb… florian 218 _help_max_statement_spacing:
6ea30fb… florian 219 - Require no more than this many newlines between statements
6ea30fb… florian 220 max_statement_spacing: 2
6ea30fb… florian 221 max_returns: 6
6ea30fb… florian 222 max_branches: 12
6ea30fb… florian 223 max_arguments: 5
6ea30fb… florian 224 max_localvars: 15
6ea30fb… florian 225 max_statements: 50
6ea30fb… florian 226 _help_encode: Options affecting file encoding
6ea30fb… florian 227 encode:
6ea30fb… florian 228 _help_emit_byteorder_mark:
6ea30fb… florian 229 - If true, emit the unicode byte-order mark (BOM) at the start
6ea30fb… florian 230 - of the file
6ea30fb… florian 231 emit_byteorder_mark: false
6ea30fb… florian 232 _help_input_encoding:
6ea30fb… florian 233 - Specify the encoding of the input file. Defaults to utf-8
6ea30fb… florian 234 input_encoding: utf-8
6ea30fb… florian 235 _help_output_encoding:
6ea30fb… florian 236 - Specify the encoding of the output file. Defaults to utf-8.
6ea30fb… florian 237 - Note that cmake only claims to support utf-8 so be careful
6ea30fb… florian 238 - when using anything else
6ea30fb… florian 239 output_encoding: utf-8
6ea30fb… florian 240 _help_misc: Miscellaneous configurations options.
6ea30fb… florian 241 misc:
6ea30fb… florian 242 _help_per_command:
6ea30fb… florian 243 - A dictionary containing any per-command configuration
6ea30fb… florian 244 - overrides. Currently only `command_case` is supported.
6ea30fb… florian 245 per_command: {}

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button