github-mirror/linux
1
0
Fork 0
mirror of https://github.com/torvalds/linux.git synced 2026-05-30 18:13:41 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity Graph

docs: kabi: helpers: add documentation for each "enum" value

Browse Source 
Ensure that kABI module documentation will describe each
debug bit.

Signed-off-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Message-ID: <3b118b157e52d757bf82fd74f03b0f4bd9e8b8f1.1768838938.git.mchehab+huawei@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab 2026-01-19 17:23:24 +01:00 committed by Jonathan Corbet
parent 5c9ece0b02
commit b713adadf8
1 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
tools/lib/python/abi/helpers.py
View File

@ -13,28 +13,28 @@ ABI_DIR = "Documentation/ABI/"
class AbiDebug:
"""Debug levels"""
WHAT_PARSING = 1
WHAT_OPEN = 2
DUMP_ABI_STRUCTS = 4
UNDEFINED = 8
REGEX = 16
SUBGROUP_MAP = 32
SUBGROUP_DICT = 64
SUBGROUP_SIZE = 128
GRAPH = 256
WHAT_PARSING = 1 #: Enable debug parsing logic.
WHAT_OPEN = 2 #: Enable debug messages on file open.
DUMP_ABI_STRUCTS = 4 #: Enable debug for ABI parse data.
UNDEFINED = 8 #: Enable extra undefined symbol data.
REGEX = 16 #: Enable debug for what to regex conversion.
SUBGROUP_MAP = 32 #: Enable debug for symbol regex subgroups
SUBGROUP_DICT = 64 #: Enable debug for sysfs graph tree variable.
SUBGROUP_SIZE = 128 #: Enable debug of search groups.
GRAPH = 256 #: Display ref tree graph for undefined symbols.
#: Helper messages for each debug variable
DEBUG_HELP = """
1 - enable debug parsing logic
2 - enable debug messages on file open
4 - enable debug for ABI parse data
8 - enable extra debug information to identify troubles
with ABI symbols found at the local machine that
weren't found on ABI documentation (used only for
undefined subcommand)
16 - enable debug for what to regex conversion
32 - enable debug for symbol regex subgroups
64 - enable debug for sysfs graph tree variable
1 - enable debug parsing logic
2 - enable debug messages on file open
4 - enable debug for ABI parse data
8 - enable extra debug information to identify troubles
with ABI symbols found at the local machine that
weren't found on ABI documentation (used only for
undefined subcommand)
16 - enable debug for what to regex conversion
32 - enable debug for symbol regex subgroups
64 - enable debug for sysfs graph tree variable
128 - enable debug of search groups
256 - enable displaying refrence tree graphs for undefined symbols.
"""