.clang-format

   1 # SPDX-License-Identifier: GPL-2.0
   2 #
   3 # clang-format configuration file. Intended for clang-format >= 4.
   4 #
   5 # For more information, see:
   6 #
   7 #   Documentation/process/clang-format.rst
   8 #   https://clang.llvm.org/docs/ClangFormat.html
   9 #   https://clang.llvm.org/docs/ClangFormatStyleOptions.html
  10 #
  11 ---
  12 AccessModifierOffset: -4
  13 AlignAfterOpenBracket: Align
  14 AlignConsecutiveAssignments: false
  15 AlignConsecutiveDeclarations: false
  16 #AlignEscapedNewlines: Left # Unknown to clang-format-4.0
  17 AlignOperands: true
  18 AlignTrailingComments: false
  19 AllowAllParametersOfDeclarationOnNextLine: false
  20 AllowShortBlocksOnASingleLine: false
  21 AllowShortCaseLabelsOnASingleLine: false
  22 AllowShortFunctionsOnASingleLine: None
  23 AllowShortIfStatementsOnASingleLine: false
  24 AllowShortLoopsOnASingleLine: false
  25 AlwaysBreakAfterDefinitionReturnType: None
  26 AlwaysBreakAfterReturnType: None
  27 AlwaysBreakBeforeMultilineStrings: false
  28 AlwaysBreakTemplateDeclarations: false
  29 BinPackArguments: true
  30 BinPackParameters: true
  31 BraceWrapping:
  32   AfterClass: false
  33   AfterControlStatement: false
  34   AfterEnum: false
  35   AfterFunction: true
  36   AfterNamespace: true
  37   AfterObjCDeclaration: false
  38   AfterStruct: false
  39   AfterUnion: false
  40   #AfterExternBlock: false # Unknown to clang-format-5.0
  41   BeforeCatch: false
  42   BeforeElse: false
  43   IndentBraces: false
  44   #SplitEmptyFunction: true # Unknown to clang-format-4.0
  45   #SplitEmptyRecord: true # Unknown to clang-format-4.0
  46   #SplitEmptyNamespace: true # Unknown to clang-format-4.0
  47 BreakBeforeBinaryOperators: None
  48 BreakBeforeBraces: Custom
  49 #BreakBeforeInheritanceComma: false # Unknown to clang-format-4.0
  50 BreakBeforeTernaryOperators: false
  51 BreakConstructorInitializersBeforeComma: false
  52 #BreakConstructorInitializers: BeforeComma # Unknown to clang-format-4.0
  53 BreakAfterJavaFieldAnnotations: false
  54 BreakStringLiterals: false
  55 ColumnLimit: 80
  56 CommentPragmas: '^ IWYU pragma:'
  57 #CompactNamespaces: false # Unknown to clang-format-4.0
  58 ConstructorInitializerAllOnOneLineOrOnePerLine: false
  59 ConstructorInitializerIndentWidth: 8
  60 ContinuationIndentWidth: 8
  61 Cpp11BracedListStyle: false
  62 DerivePointerAlignment: false
  63 DisableFormat: false
  64 ExperimentalAutoDetectBinPacking: false
  65 #FixNamespaceComments: false # Unknown to clang-format-4.0
  66
  67 # Taken from:
  68 #   git grep -h '^#define [^[:space:]]*for_each[^[:space:]]*(' include/ \
  69 #   | sed "s,^#define \([^[:space:]]*for_each[^[:space:]]*\)(.*$,  - '\1'," \
  70 #   | sort | uniq
  71 ForEachMacros:
  72   - 'apei_estatus_for_each_section'
  73   - 'ata_for_each_dev'
  74   - 'ata_for_each_link'
  75   - '__ata_qc_for_each'
  76   - 'ata_qc_for_each'
  77   - 'ata_qc_for_each_raw'
  78   - 'ata_qc_for_each_with_internal'
  79   - 'ax25_for_each'
  80   - 'ax25_uid_for_each'
  81   - '__bio_for_each_bvec'
  82   - 'bio_for_each_bvec'
  83   - 'bio_for_each_integrity_vec'
  84   - '__bio_for_each_segment'
  85   - 'bio_for_each_segment'
  86   - 'bio_for_each_segment_all'
  87   - 'bio_list_for_each'
  88   - 'bip_for_each_vec'
  89   - 'blkg_for_each_descendant_post'
  90   - 'blkg_for_each_descendant_pre'
  91   - 'blk_queue_for_each_rl'
  92   - 'bond_for_each_slave'
  93   - 'bond_for_each_slave_rcu'
  94   - 'bpf_for_each_spilled_reg'
  95   - 'btree_for_each_safe128'
  96   - 'btree_for_each_safe32'
  97   - 'btree_for_each_safe64'
  98   - 'btree_for_each_safel'
  99   - 'card_for_each_dev'
 100   - 'cgroup_taskset_for_each'
 101   - 'cgroup_taskset_for_each_leader'
 102   - 'cpufreq_for_each_entry'
 103   - 'cpufreq_for_each_entry_idx'
 104   - 'cpufreq_for_each_valid_entry'
 105   - 'cpufreq_for_each_valid_entry_idx'
 106   - 'css_for_each_child'
 107   - 'css_for_each_descendant_post'
 108   - 'css_for_each_descendant_pre'
 109   - 'device_for_each_child_node'
 110   - 'dma_fence_chain_for_each'
 111   - 'drm_atomic_crtc_for_each_plane'
 112   - 'drm_atomic_crtc_state_for_each_plane'
 113   - 'drm_atomic_crtc_state_for_each_plane_state'
 114   - 'drm_atomic_for_each_plane_damage'
 115   - 'drm_client_for_each_connector_iter'
 116   - 'drm_client_for_each_modeset'
 117   - 'drm_connector_for_each_possible_encoder'
 118   - 'drm_for_each_connector_iter'
 119   - 'drm_for_each_crtc'
 120   - 'drm_for_each_encoder'
 121   - 'drm_for_each_encoder_mask'
 122   - 'drm_for_each_fb'
 123   - 'drm_for_each_legacy_plane'
 124   - 'drm_for_each_plane'
 125   - 'drm_for_each_plane_mask'
 126   - 'drm_for_each_privobj'
 127   - 'drm_mm_for_each_hole'
 128   - 'drm_mm_for_each_node'
 129   - 'drm_mm_for_each_node_in_range'
 130   - 'drm_mm_for_each_node_safe'
 131   - 'flow_action_for_each'
 132   - 'for_each_active_dev_scope'
 133   - 'for_each_active_drhd_unit'
 134   - 'for_each_active_iommu'
 135   - 'for_each_available_child_of_node'
 136   - 'for_each_bio'
 137   - 'for_each_board_func_rsrc'
 138   - 'for_each_bvec'
 139   - 'for_each_card_components'
 140   - 'for_each_card_links'
 141   - 'for_each_card_links_safe'
 142   - 'for_each_card_prelinks'
 143   - 'for_each_card_rtds'
 144   - 'for_each_card_rtds_safe'
 145   - 'for_each_cgroup_storage_type'
 146   - 'for_each_child_of_node'
 147   - 'for_each_clear_bit'
 148   - 'for_each_clear_bit_from'
 149   - 'for_each_cmsghdr'
 150   - 'for_each_compatible_node'
 151   - 'for_each_component_dais'
 152   - 'for_each_component_dais_safe'
 153   - 'for_each_comp_order'
 154   - 'for_each_console'
 155   - 'for_each_cpu'
 156   - 'for_each_cpu_and'
 157   - 'for_each_cpu_not'
 158   - 'for_each_cpu_wrap'
 159   - 'for_each_dev_addr'
 160   - 'for_each_dev_scope'
 161   - 'for_each_displayid_db'
 162   - 'for_each_dma_cap_mask'
 163   - 'for_each_dpcm_be'
 164   - 'for_each_dpcm_be_rollback'
 165   - 'for_each_dpcm_be_safe'
 166   - 'for_each_dpcm_fe'
 167   - 'for_each_drhd_unit'
 168   - 'for_each_dss_dev'
 169   - 'for_each_efi_memory_desc'
 170   - 'for_each_efi_memory_desc_in_map'
 171   - 'for_each_element'
 172   - 'for_each_element_extid'
 173   - 'for_each_element_id'
 174   - 'for_each_endpoint_of_node'
 175   - 'for_each_evictable_lru'
 176   - 'for_each_fib6_node_rt_rcu'
 177   - 'for_each_fib6_walker_rt'
 178   - 'for_each_free_mem_pfn_range_in_zone'
 179   - 'for_each_free_mem_pfn_range_in_zone_from'
 180   - 'for_each_free_mem_range'
 181   - 'for_each_free_mem_range_reverse'
 182   - 'for_each_func_rsrc'
 183   - 'for_each_hstate'
 184   - 'for_each_if'
 185   - 'for_each_iommu'
 186   - 'for_each_ip_tunnel_rcu'
 187   - 'for_each_irq_nr'
 188   - 'for_each_link_codecs'
 189   - 'for_each_link_platforms'
 190   - 'for_each_lru'
 191   - 'for_each_matching_node'
 192   - 'for_each_matching_node_and_match'
 193   - 'for_each_memblock'
 194   - 'for_each_memblock_type'
 195   - 'for_each_memcg_cache_index'
 196   - 'for_each_mem_pfn_range'
 197   - 'for_each_mem_range'
 198   - 'for_each_mem_range_rev'
 199   - 'for_each_migratetype_order'
 200   - 'for_each_msi_entry'
 201   - 'for_each_msi_entry_safe'
 202   - 'for_each_net'
 203   - 'for_each_netdev'
 204   - 'for_each_netdev_continue'
 205   - 'for_each_netdev_continue_rcu'
 206   - 'for_each_netdev_feature'
 207   - 'for_each_netdev_in_bond_rcu'
 208   - 'for_each_netdev_rcu'
 209   - 'for_each_netdev_reverse'
 210   - 'for_each_netdev_safe'
 211   - 'for_each_net_rcu'
 212   - 'for_each_new_connector_in_state'
 213   - 'for_each_new_crtc_in_state'
 214   - 'for_each_new_mst_mgr_in_state'
 215   - 'for_each_new_plane_in_state'
 216   - 'for_each_new_private_obj_in_state'
 217   - 'for_each_node'
 218   - 'for_each_node_by_name'
 219   - 'for_each_node_by_type'
 220   - 'for_each_node_mask'
 221   - 'for_each_node_state'
 222   - 'for_each_node_with_cpus'
 223   - 'for_each_node_with_property'
 224   - 'for_each_of_allnodes'
 225   - 'for_each_of_allnodes_from'
 226   - 'for_each_of_cpu_node'
 227   - 'for_each_of_pci_range'
 228   - 'for_each_old_connector_in_state'
 229   - 'for_each_old_crtc_in_state'
 230   - 'for_each_old_mst_mgr_in_state'
 231   - 'for_each_oldnew_connector_in_state'
 232   - 'for_each_oldnew_crtc_in_state'
 233   - 'for_each_oldnew_mst_mgr_in_state'
 234   - 'for_each_oldnew_plane_in_state'
 235   - 'for_each_oldnew_plane_in_state_reverse'
 236   - 'for_each_oldnew_private_obj_in_state'
 237   - 'for_each_old_plane_in_state'
 238   - 'for_each_old_private_obj_in_state'
 239   - 'for_each_online_cpu'
 240   - 'for_each_online_node'
 241   - 'for_each_online_pgdat'
 242   - 'for_each_pci_bridge'
 243   - 'for_each_pci_dev'
 244   - 'for_each_pci_msi_entry'
 245   - 'for_each_populated_zone'
 246   - 'for_each_possible_cpu'
 247   - 'for_each_present_cpu'
 248   - 'for_each_prime_number'
 249   - 'for_each_prime_number_from'
 250   - 'for_each_process'
 251   - 'for_each_process_thread'
 252   - 'for_each_property_of_node'
 253   - 'for_each_registered_fb'
 254   - 'for_each_reserved_mem_region'
 255   - 'for_each_rtd_codec_dai'
 256   - 'for_each_rtd_codec_dai_rollback'
 257   - 'for_each_rtdcom'
 258   - 'for_each_rtdcom_safe'
 259   - 'for_each_set_bit'
 260   - 'for_each_set_bit_from'
 261   - 'for_each_sg'
 262   - 'for_each_sg_dma_page'
 263   - 'for_each_sg_page'
 264   - 'for_each_sibling_event'
 265   - 'for_each_subelement'
 266   - 'for_each_subelement_extid'
 267   - 'for_each_subelement_id'
 268   - '__for_each_thread'
 269   - 'for_each_thread'
 270   - 'for_each_zone'
 271   - 'for_each_zone_zonelist'
 272   - 'for_each_zone_zonelist_nodemask'
 273   - 'fwnode_for_each_available_child_node'
 274   - 'fwnode_for_each_child_node'
 275   - 'fwnode_graph_for_each_endpoint'
 276   - 'gadget_for_each_ep'
 277   - 'genradix_for_each'
 278   - 'genradix_for_each_from'
 279   - 'hash_for_each'
 280   - 'hash_for_each_possible'
 281   - 'hash_for_each_possible_rcu'
 282   - 'hash_for_each_possible_rcu_notrace'
 283   - 'hash_for_each_possible_safe'
 284   - 'hash_for_each_rcu'
 285   - 'hash_for_each_safe'
 286   - 'hctx_for_each_ctx'
 287   - 'hlist_bl_for_each_entry'
 288   - 'hlist_bl_for_each_entry_rcu'
 289   - 'hlist_bl_for_each_entry_safe'
 290   - 'hlist_for_each'
 291   - 'hlist_for_each_entry'
 292   - 'hlist_for_each_entry_continue'
 293   - 'hlist_for_each_entry_continue_rcu'
 294   - 'hlist_for_each_entry_continue_rcu_bh'
 295   - 'hlist_for_each_entry_from'
 296   - 'hlist_for_each_entry_from_rcu'
 297   - 'hlist_for_each_entry_rcu'
 298   - 'hlist_for_each_entry_rcu_bh'
 299   - 'hlist_for_each_entry_rcu_notrace'
 300   - 'hlist_for_each_entry_safe'
 301   - '__hlist_for_each_rcu'
 302   - 'hlist_for_each_safe'
 303   - 'hlist_nulls_for_each_entry'
 304   - 'hlist_nulls_for_each_entry_from'
 305   - 'hlist_nulls_for_each_entry_rcu'
 306   - 'hlist_nulls_for_each_entry_safe'
 307   - 'i3c_bus_for_each_i2cdev'
 308   - 'i3c_bus_for_each_i3cdev'
 309   - 'ide_host_for_each_port'
 310   - 'ide_port_for_each_dev'
 311   - 'ide_port_for_each_present_dev'
 312   - 'idr_for_each_entry'
 313   - 'idr_for_each_entry_continue'
 314   - 'idr_for_each_entry_continue_ul'
 315   - 'idr_for_each_entry_ul'
 316   - 'in_dev_for_each_ifa_rcu'
 317   - 'in_dev_for_each_ifa_rtnl'
 318   - 'inet_bind_bucket_for_each'
 319   - 'inet_lhash2_for_each_icsk_rcu'
 320   - 'key_for_each'
 321   - 'key_for_each_safe'
 322   - 'klp_for_each_func'
 323   - 'klp_for_each_func_safe'
 324   - 'klp_for_each_func_static'
 325   - 'klp_for_each_object'
 326   - 'klp_for_each_object_safe'
 327   - 'klp_for_each_object_static'
 328   - 'kvm_for_each_memslot'
 329   - 'kvm_for_each_vcpu'
 330   - 'list_for_each'
 331   - 'list_for_each_codec'
 332   - 'list_for_each_codec_safe'
 333   - 'list_for_each_entry'
 334   - 'list_for_each_entry_continue'
 335   - 'list_for_each_entry_continue_rcu'
 336   - 'list_for_each_entry_continue_reverse'
 337   - 'list_for_each_entry_from'
 338   - 'list_for_each_entry_from_rcu'
 339   - 'list_for_each_entry_from_reverse'
 340   - 'list_for_each_entry_lockless'
 341   - 'list_for_each_entry_rcu'
 342   - 'list_for_each_entry_reverse'
 343   - 'list_for_each_entry_safe'
 344   - 'list_for_each_entry_safe_continue'
 345   - 'list_for_each_entry_safe_from'
 346   - 'list_for_each_entry_safe_reverse'
 347   - 'list_for_each_prev'
 348   - 'list_for_each_prev_safe'
 349   - 'list_for_each_safe'
 350   - 'llist_for_each'
 351   - 'llist_for_each_entry'
 352   - 'llist_for_each_entry_safe'
 353   - 'llist_for_each_safe'
 354   - 'media_device_for_each_entity'
 355   - 'media_device_for_each_intf'
 356   - 'media_device_for_each_link'
 357   - 'media_device_for_each_pad'
 358   - 'nanddev_io_for_each_page'
 359   - 'netdev_for_each_lower_dev'
 360   - 'netdev_for_each_lower_private'
 361   - 'netdev_for_each_lower_private_rcu'
 362   - 'netdev_for_each_mc_addr'
 363   - 'netdev_for_each_uc_addr'
 364   - 'netdev_for_each_upper_dev_rcu'
 365   - 'netdev_hw_addr_list_for_each'
 366   - 'nft_rule_for_each_expr'
 367   - 'nla_for_each_attr'
 368   - 'nla_for_each_nested'
 369   - 'nlmsg_for_each_attr'
 370   - 'nlmsg_for_each_msg'
 371   - 'nr_neigh_for_each'
 372   - 'nr_neigh_for_each_safe'
 373   - 'nr_node_for_each'
 374   - 'nr_node_for_each_safe'
 375   - 'of_for_each_phandle'
 376   - 'of_property_for_each_string'
 377   - 'of_property_for_each_u32'
 378   - 'pci_bus_for_each_resource'
 379   - 'ping_portaddr_for_each_entry'
 380   - 'plist_for_each'
 381   - 'plist_for_each_continue'
 382   - 'plist_for_each_entry'
 383   - 'plist_for_each_entry_continue'
 384   - 'plist_for_each_entry_safe'
 385   - 'plist_for_each_safe'
 386   - 'pnp_for_each_card'
 387   - 'pnp_for_each_dev'
 388   - 'protocol_for_each_card'
 389   - 'protocol_for_each_dev'
 390   - 'queue_for_each_hw_ctx'
 391   - 'radix_tree_for_each_slot'
 392   - 'radix_tree_for_each_tagged'
 393   - 'rbtree_postorder_for_each_entry_safe'
 394   - 'rdma_for_each_block'
 395   - 'rdma_for_each_port'
 396   - 'resource_list_for_each_entry'
 397   - 'resource_list_for_each_entry_safe'
 398   - 'rhl_for_each_entry_rcu'
 399   - 'rhl_for_each_rcu'
 400   - 'rht_for_each'
 401   - 'rht_for_each_entry'
 402   - 'rht_for_each_entry_from'
 403   - 'rht_for_each_entry_rcu'
 404   - 'rht_for_each_entry_rcu_from'
 405   - 'rht_for_each_entry_safe'
 406   - 'rht_for_each_from'
 407   - 'rht_for_each_rcu'
 408   - 'rht_for_each_rcu_from'
 409   - '__rq_for_each_bio'
 410   - 'rq_for_each_bvec'
 411   - 'rq_for_each_segment'
 412   - 'scsi_for_each_prot_sg'
 413   - 'scsi_for_each_sg'
 414   - 'sctp_for_each_hentry'
 415   - 'sctp_skb_for_each'
 416   - 'shdma_for_each_chan'
 417   - '__shost_for_each_device'
 418   - 'shost_for_each_device'
 419   - 'sk_for_each'
 420   - 'sk_for_each_bound'
 421   - 'sk_for_each_entry_offset_rcu'
 422   - 'sk_for_each_from'
 423   - 'sk_for_each_rcu'
 424   - 'sk_for_each_safe'
 425   - 'sk_nulls_for_each'
 426   - 'sk_nulls_for_each_from'
 427   - 'sk_nulls_for_each_rcu'
 428   - 'snd_array_for_each'
 429   - 'snd_pcm_group_for_each_entry'
 430   - 'snd_soc_dapm_widget_for_each_path'
 431   - 'snd_soc_dapm_widget_for_each_path_safe'
 432   - 'snd_soc_dapm_widget_for_each_sink_path'
 433   - 'snd_soc_dapm_widget_for_each_source_path'
 434   - 'tb_property_for_each'
 435   - 'tcf_exts_for_each_action'
 436   - 'udp_portaddr_for_each_entry'
 437   - 'udp_portaddr_for_each_entry_rcu'
 438   - 'usb_hub_for_each_child'
 439   - 'v4l2_device_for_each_subdev'
 440   - 'v4l2_m2m_for_each_dst_buf'
 441   - 'v4l2_m2m_for_each_dst_buf_safe'
 442   - 'v4l2_m2m_for_each_src_buf'
 443   - 'v4l2_m2m_for_each_src_buf_safe'
 444   - 'virtio_device_for_each_vq'
 445   - 'xa_for_each'
 446   - 'xa_for_each_marked'
 447   - 'xa_for_each_start'
 448   - 'xas_for_each'
 449   - 'xas_for_each_conflict'
 450   - 'xas_for_each_marked'
 451   - 'zorro_for_each_dev'
 452
 453 #IncludeBlocks: Preserve # Unknown to clang-format-5.0
 454 IncludeCategories:
 455   - Regex: '.*'
 456     Priority: 1
 457 IncludeIsMainRegex: '(Test)?$'
 458 IndentCaseLabels: false
 459 #IndentPPDirectives: None # Unknown to clang-format-5.0
 460 IndentWidth: 8
 461 IndentWrappedFunctionNames: false
 462 JavaScriptQuotes: Leave
 463 JavaScriptWrapImports: true
 464 KeepEmptyLinesAtTheStartOfBlocks: false
 465 MacroBlockBegin: ''
 466 MacroBlockEnd: ''
 467 MaxEmptyLinesToKeep: 1
 468 NamespaceIndentation: Inner
 469 #ObjCBinPackProtocolList: Auto # Unknown to clang-format-5.0
 470 ObjCBlockIndentWidth: 8
 471 ObjCSpaceAfterProperty: true
 472 ObjCSpaceBeforeProtocolList: true
 473
 474 # Taken from git's rules
 475 #PenaltyBreakAssignment: 10 # Unknown to clang-format-4.0
 476 PenaltyBreakBeforeFirstCallParameter: 30
 477 PenaltyBreakComment: 10
 478 PenaltyBreakFirstLessLess: 0
 479 PenaltyBreakString: 10
 480 PenaltyExcessCharacter: 100
 481 PenaltyReturnTypeOnItsOwnLine: 60
 482
 483 PointerAlignment: Right
 484 ReflowComments: false
 485 SortIncludes: false
 486 #SortUsingDeclarations: false # Unknown to clang-format-4.0
 487 SpaceAfterCStyleCast: false
 488 SpaceAfterTemplateKeyword: true
 489 SpaceBeforeAssignmentOperators: true
 490 #SpaceBeforeCtorInitializerColon: true # Unknown to clang-format-5.0
 491 #SpaceBeforeInheritanceColon: true # Unknown to clang-format-5.0
 492 SpaceBeforeParens: ControlStatements
 493 #SpaceBeforeRangeBasedForLoopColon: true # Unknown to clang-format-5.0
 494 SpaceInEmptyParentheses: false
 495 SpacesBeforeTrailingComments: 1
 496 SpacesInAngles: false
 497 SpacesInContainerLiterals: false
 498 SpacesInCStyleCastParentheses: false
 499 SpacesInParentheses: false
 500 SpacesInSquareBrackets: false
 501 Standard: Cpp03
 502 TabWidth: 8
 503 UseTab: Always
 504 ...