mirror of
https://github.com/torvalds/linux.git
synced 2026-04-18 23:03:57 -04:00
docs: xforms_lists: use CMatch for all identifiers
CMatch is lexically correct and replaces only identifiers, which is exactly where macro transformations happen. Use it to make the output safer and ensure that all arguments will be parsed the right way, even on complex cases. Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <86d4a07ff0e054207747fabf38d6bb261b52b5fa.1773770483.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab
committed by
Jonathan Corbet
Jonathan Corbet
parent
79d881beb7
commit
7538df7a2d
@@ -7,7 +7,8 @@ import re
|
||||
from kdoc.kdoc_re import KernRe
|
||||
from kdoc.c_lex import CMatch, CTokenizer
|
||||
|
||||
struct_args_pattern = r'([^,)]+)'
|
||||
struct_args_pattern = r"([^,)]+)"
|
||||
|
||||
|
||||
class CTransforms:
|
||||
"""
|
||||
@@ -24,48 +25,40 @@ class CTransforms:
|
||||
|
||||
#: Transforms for structs and unions.
|
||||
struct_xforms = [
|
||||
# Strip attributes
|
||||
(KernRe(r"__attribute__\s*\(\([a-z0-9,_\*\s\(\)]*\)\)", flags=re.I | re.S, cache=False), ' '),
|
||||
(KernRe(r'\s*__aligned\s*\([^;]*\)', re.S), ' '),
|
||||
(KernRe(r'\s*__counted_by\s*\([^;]*\)', re.S), ' '),
|
||||
(KernRe(r'\s*__counted_by_(le|be)\s*\([^;]*\)', re.S), ' '),
|
||||
(KernRe(r'\s*__guarded_by\s*\([^\)]*\)', re.S), ' '),
|
||||
(KernRe(r'\s*__pt_guarded_by\s*\([^\)]*\)', re.S), ' '),
|
||||
(KernRe(r'\s*__packed\s*', re.S), ' '),
|
||||
(KernRe(r'\s*CRYPTO_MINALIGN_ATTR', re.S), ' '),
|
||||
(KernRe(r'\s*__private', re.S), ' '),
|
||||
(KernRe(r'\s*__rcu', re.S), ' '),
|
||||
(KernRe(r'\s*____cacheline_aligned_in_smp', re.S), ' '),
|
||||
(KernRe(r'\s*____cacheline_aligned', re.S), ' '),
|
||||
(KernRe(r'\s*__cacheline_group_(begin|end)\([^\)]+\);'), ''),
|
||||
(KernRe(r'__ETHTOOL_DECLARE_LINK_MODE_MASK\s*\(([^\)]+)\)', re.S),
|
||||
r'DECLARE_BITMAP(\1, __ETHTOOL_LINK_MODE_MASK_NBITS)'),
|
||||
(KernRe(r'DECLARE_PHY_INTERFACE_MASK\s*\(([^\)]+)\)', re.S),
|
||||
r'DECLARE_BITMAP(\1, PHY_INTERFACE_MODE_MAX)'),
|
||||
(KernRe(r'DECLARE_BITMAP\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern + r'\)',
|
||||
re.S), r'unsigned long \1[BITS_TO_LONGS(\2)]'),
|
||||
(KernRe(r'DECLARE_HASHTABLE\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern + r'\)',
|
||||
re.S), r'unsigned long \1[1 << ((\2) - 1)]'),
|
||||
(KernRe(r'DECLARE_KFIFO\s*\(' + struct_args_pattern + r',\s*' + struct_args_pattern +
|
||||
r',\s*' + struct_args_pattern + r'\)', re.S), r'\2 *\1'),
|
||||
(KernRe(r'DECLARE_KFIFO_PTR\s*\(' + struct_args_pattern + r',\s*' +
|
||||
struct_args_pattern + r'\)', re.S), r'\2 *\1'),
|
||||
(KernRe(r'(?:__)?DECLARE_FLEX_ARRAY\s*\(' + struct_args_pattern + r',\s*' +
|
||||
struct_args_pattern + r'\)', re.S), r'\1 \2[]'),
|
||||
(KernRe(r'DEFINE_DMA_UNMAP_ADDR\s*\(' + struct_args_pattern + r'\)', re.S), r'dma_addr_t \1'),
|
||||
(KernRe(r'DEFINE_DMA_UNMAP_LEN\s*\(' + struct_args_pattern + r'\)', re.S), r'__u32 \1'),
|
||||
(KernRe(r'VIRTIO_DECLARE_FEATURES\(([\w_]+)\)'), r'union { u64 \1; u64 \1_array[VIRTIO_FEATURES_U64S]; }'),
|
||||
|
||||
(CMatch(r"__cond_acquires"), ""),
|
||||
(CMatch(r"__cond_releases"), ""),
|
||||
(CMatch(r"__acquires"), ""),
|
||||
(CMatch(r"__releases"), ""),
|
||||
(CMatch(r"__must_hold"), ""),
|
||||
(CMatch(r"__must_not_hold"), ""),
|
||||
(CMatch(r"__must_hold_shared"), ""),
|
||||
(CMatch(r"__cond_acquires_shared"), ""),
|
||||
(CMatch(r"__acquires_shared"), ""),
|
||||
(CMatch(r"__releases_shared"), ""),
|
||||
(CMatch("__attribute__"), ""),
|
||||
(CMatch("__aligned"), ""),
|
||||
(CMatch("__counted_by"), ""),
|
||||
(CMatch("__counted_by_(le|be)"), ""),
|
||||
(CMatch("__guarded_by"), ""),
|
||||
(CMatch("__pt_guarded_by"), ""),
|
||||
(CMatch("__packed"), ""),
|
||||
(CMatch("CRYPTO_MINALIGN_ATTR"), ""),
|
||||
(CMatch("__private"), ""),
|
||||
(CMatch("__rcu"), ""),
|
||||
(CMatch("____cacheline_aligned_in_smp"), ""),
|
||||
(CMatch("____cacheline_aligned"), ""),
|
||||
(CMatch("__cacheline_group_(?:begin|end)"), ""),
|
||||
(CMatch("__ETHTOOL_DECLARE_LINK_MODE_MASK"), r"DECLARE_BITMAP(\1, __ETHTOOL_LINK_MODE_MASK_NBITS)"),
|
||||
(CMatch("DECLARE_PHY_INTERFACE_MASK",),r"DECLARE_BITMAP(\1, PHY_INTERFACE_MODE_MAX)"),
|
||||
(CMatch("DECLARE_BITMAP"), r"unsigned long \1[BITS_TO_LONGS(\2)]"),
|
||||
(CMatch("DECLARE_HASHTABLE"), r"unsigned long \1[1 << ((\2) - 1)]"),
|
||||
(CMatch("DECLARE_KFIFO"), r"\2 *\1"),
|
||||
(CMatch("DECLARE_KFIFO_PTR"), r"\2 *\1"),
|
||||
(CMatch("(?:__)?DECLARE_FLEX_ARRAY"), r"\1 \2[]"),
|
||||
(CMatch("DEFINE_DMA_UNMAP_ADDR"), r"dma_addr_t \1"),
|
||||
(CMatch("DEFINE_DMA_UNMAP_LEN"), r"__u32 \1"),
|
||||
(CMatch("VIRTIO_DECLARE_FEATURES"), r"union { u64 \1; u64 \1_array[VIRTIO_FEATURES_U64S]; }"),
|
||||
(CMatch("__cond_acquires"), ""),
|
||||
(CMatch("__cond_releases"), ""),
|
||||
(CMatch("__acquires"), ""),
|
||||
(CMatch("__releases"), ""),
|
||||
(CMatch("__must_hold"), ""),
|
||||
(CMatch("__must_not_hold"), ""),
|
||||
(CMatch("__must_hold_shared"), ""),
|
||||
(CMatch("__cond_acquires_shared"), ""),
|
||||
(CMatch("__acquires_shared"), ""),
|
||||
(CMatch("__releases_shared"), ""),
|
||||
(CMatch("__attribute__"), ""),
|
||||
|
||||
#
|
||||
# Macro __struct_group() creates an union with an anonymous
|
||||
@@ -73,51 +66,57 @@ class CTransforms:
|
||||
# need one of those at kernel-doc, as we won't be documenting the same
|
||||
# members twice.
|
||||
#
|
||||
(CMatch('struct_group'), r'struct { \2+ };'),
|
||||
(CMatch('struct_group_attr'), r'struct { \3+ };'),
|
||||
(CMatch('struct_group_tagged'), r'struct { \3+ };'),
|
||||
(CMatch('__struct_group'), r'struct { \4+ };'),
|
||||
|
||||
(CMatch("struct_group"), r"struct { \2+ };"),
|
||||
(CMatch("struct_group_attr"), r"struct { \3+ };"),
|
||||
(CMatch("struct_group_tagged"), r"struct { \3+ };"),
|
||||
(CMatch("__struct_group"), r"struct { \4+ };"),
|
||||
]
|
||||
|
||||
#: Transforms for function prototypes.
|
||||
function_xforms = [
|
||||
(KernRe(r"^static +"), ""),
|
||||
(KernRe(r"^extern +"), ""),
|
||||
(KernRe(r"^asmlinkage +"), ""),
|
||||
(KernRe(r"^inline +"), ""),
|
||||
(KernRe(r"^__inline__ +"), ""),
|
||||
(KernRe(r"^__inline +"), ""),
|
||||
(KernRe(r"^__always_inline +"), ""),
|
||||
(KernRe(r"^noinline +"), ""),
|
||||
(KernRe(r"^__FORTIFY_INLINE +"), ""),
|
||||
(KernRe(r"__init +"), ""),
|
||||
(KernRe(r"__init_or_module +"), ""),
|
||||
(KernRe(r"__exit +"), ""),
|
||||
(KernRe(r"__deprecated +"), ""),
|
||||
(KernRe(r"__flatten +"), ""),
|
||||
(KernRe(r"__meminit +"), ""),
|
||||
(KernRe(r"__must_check +"), ""),
|
||||
(KernRe(r"__weak +"), ""),
|
||||
(KernRe(r"__sched +"), ""),
|
||||
(KernRe(r"_noprof"), ""),
|
||||
(KernRe(r"__always_unused *"), ""),
|
||||
(KernRe(r"__printf\s*\(\s*\d*\s*,\s*\d*\s*\) +"), ""),
|
||||
(KernRe(r"__(?:re)?alloc_size\s*\(\s*\d+\s*(?:,\s*\d+\s*)?\) +"), ""),
|
||||
(KernRe(r"__diagnose_as\s*\(\s*\S+\s*(?:,\s*\d+\s*)*\) +"), ""),
|
||||
(KernRe(r"DECL_BUCKET_PARAMS\s*\(\s*(\S+)\s*,\s*(\S+)\s*\)"), r"\1, \2"),
|
||||
(KernRe(r"__no_context_analysis\s*"), ""),
|
||||
(KernRe(r"__attribute_const__ +"), ""),
|
||||
(KernRe(r"__attribute__\s*\(\((?:[\w\s]+(?:\([^)]*\))?\s*,?)+\)\)\s+"), ""),
|
||||
(CMatch("static"), ""),
|
||||
(CMatch("extern"), ""),
|
||||
(CMatch("asmlinkage"), ""),
|
||||
(CMatch("inline"), ""),
|
||||
(CMatch("__inline__"), ""),
|
||||
(CMatch("__inline"), ""),
|
||||
(CMatch("__always_inline"), ""),
|
||||
(CMatch("noinline"), ""),
|
||||
(CMatch("__FORTIFY_INLINE"), ""),
|
||||
(CMatch("__init"), ""),
|
||||
(CMatch("__init_or_module"), ""),
|
||||
(CMatch("__exit"), ""),
|
||||
(CMatch("__deprecated"), ""),
|
||||
(CMatch("__flatten"), ""),
|
||||
(CMatch("__meminit"), ""),
|
||||
(CMatch("__must_check"), ""),
|
||||
(CMatch("__weak"), ""),
|
||||
(CMatch("__sched"), ""),
|
||||
(CMatch("__always_unused"), ""),
|
||||
(CMatch("__printf"), ""),
|
||||
(CMatch("__(?:re)?alloc_size"), ""),
|
||||
(CMatch("__diagnose_as"), ""),
|
||||
(CMatch("DECL_BUCKET_PARAMS"), r"\1, \2"),
|
||||
(CMatch("__no_context_analysis"), ""),
|
||||
(CMatch("__attribute_const__"), ""),
|
||||
(CMatch("__attribute__"), ""),
|
||||
|
||||
#
|
||||
# HACK: this is similar to process_export() hack. It is meant to
|
||||
# drop _noproof from function name. See for instance:
|
||||
# ahash_request_alloc kernel-doc declaration at include/crypto/hash.h.
|
||||
#
|
||||
(KernRe("_noprof"), ""),
|
||||
]
|
||||
|
||||
#: Transforms for variable prototypes.
|
||||
var_xforms = [
|
||||
(KernRe(r"__read_mostly"), ""),
|
||||
(KernRe(r"__ro_after_init"), ""),
|
||||
(KernRe(r'\s*__guarded_by\s*\([^\)]*\)', re.S), ""),
|
||||
(KernRe(r'\s*__pt_guarded_by\s*\([^\)]*\)', re.S), ""),
|
||||
(KernRe(r"LIST_HEAD\(([\w_]+)\)"), r"struct list_head \1"),
|
||||
(CMatch("__read_mostly"), ""),
|
||||
(CMatch("__ro_after_init"), ""),
|
||||
(CMatch("__guarded_by"), ""),
|
||||
(CMatch("__pt_guarded_by"), ""),
|
||||
(CMatch("LIST_HEAD"), r"struct list_head \1"),
|
||||
|
||||
(KernRe(r"(?://.*)$"), ""),
|
||||
(KernRe(r"(?:/\*.*\*/)"), ""),
|
||||
(KernRe(r";$"), ""),
|
||||
|
||||
Reference in New Issue
Block a user