Skip to content

Commit b713ada

Browse files
mchehabJonathan Corbet
authored andcommitted
docs: kabi: helpers: add documentation for each "enum" value
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>
1 parent 5c9ece0 commit b713ada

1 file changed

Lines changed: 20 additions & 20 deletions

File tree

tools/lib/python/abi/helpers.py

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,28 +13,28 @@
1313
class AbiDebug:
1414
"""Debug levels"""
1515

16-
WHAT_PARSING = 1
17-
WHAT_OPEN = 2
18-
DUMP_ABI_STRUCTS = 4
19-
UNDEFINED = 8
20-
REGEX = 16
21-
SUBGROUP_MAP = 32
22-
SUBGROUP_DICT = 64
23-
SUBGROUP_SIZE = 128
24-
GRAPH = 256
25-
16+
WHAT_PARSING = 1 #: Enable debug parsing logic.
17+
WHAT_OPEN = 2 #: Enable debug messages on file open.
18+
DUMP_ABI_STRUCTS = 4 #: Enable debug for ABI parse data.
19+
UNDEFINED = 8 #: Enable extra undefined symbol data.
20+
REGEX = 16 #: Enable debug for what to regex conversion.
21+
SUBGROUP_MAP = 32 #: Enable debug for symbol regex subgroups
22+
SUBGROUP_DICT = 64 #: Enable debug for sysfs graph tree variable.
23+
SUBGROUP_SIZE = 128 #: Enable debug of search groups.
24+
GRAPH = 256 #: Display ref tree graph for undefined symbols.
2625

26+
#: Helper messages for each debug variable
2727
DEBUG_HELP = """
28-
1 - enable debug parsing logic
29-
2 - enable debug messages on file open
30-
4 - enable debug for ABI parse data
31-
8 - enable extra debug information to identify troubles
32-
with ABI symbols found at the local machine that
33-
weren't found on ABI documentation (used only for
34-
undefined subcommand)
35-
16 - enable debug for what to regex conversion
36-
32 - enable debug for symbol regex subgroups
37-
64 - enable debug for sysfs graph tree variable
28+
1 - enable debug parsing logic
29+
2 - enable debug messages on file open
30+
4 - enable debug for ABI parse data
31+
8 - enable extra debug information to identify troubles
32+
with ABI symbols found at the local machine that
33+
weren't found on ABI documentation (used only for
34+
undefined subcommand)
35+
16 - enable debug for what to regex conversion
36+
32 - enable debug for symbol regex subgroups
37+
64 - enable debug for sysfs graph tree variable
3838
128 - enable debug of search groups
3939
256 - enable displaying refrence tree graphs for undefined symbols.
4040
"""

0 commit comments

Comments
 (0)