tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
doc: debugobjects: actually pull in the kerneldoc comments
Add the appropriate markup to get the kerneldoc comments out of
lib/debugobjects.c that have never seen the light of day until now.
A logical next step, left for the reader at the moment, is to move the
function descriptions *out* of debug-objects.rst and into the kerneldoc
comments themselves.
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
+15
-19
+15
-19
Documentation/core-api/debug-objects.rst
+15
-19
Documentation/core-api/debug-objects.rst
···
64
64
Debug functions
65
65
===============
66
66
67
-
Debug object function reference
68
-
-------------------------------
69
-
70
67
.. kernel-doc:: lib/debugobjects.c
71
-
:export:
72
-
73
-
debug_object_init
74
-
-------------------
68
+
:functions: debug_object_init
75
69
76
70
This function is called whenever the initialization function of a real
77
71
object is called.
···
87
93
calling code must use debug_object_init_on_stack() and remove the
88
94
object before leaving the function which allocated it. See next section.
89
95
90
-
debug_object_init_on_stack
91
-
------------------------------
96
+
.. kernel-doc:: lib/debugobjects.c
97
+
:functions: debug_object_init_on_stack
92
98
93
99
This function is called whenever the initialization function of a real
94
100
object which resides on the stack is called.
···
111
117
calling debug_object_free() before the function which allocates the
112
118
object returns. Otherwise we keep track of stale objects.
113
119
114
-
debug_object_activate
115
-
-----------------------
120
+
.. kernel-doc:: lib/debugobjects.c
121
+
:functions: debug_object_activate
116
122
117
123
This function is called whenever the activation function of a real
118
124
object is called.
···
135
141
When the activation is legitimate, then the state of the associated
136
142
tracker object is set to ODEBUG_STATE_ACTIVE.
137
143
138
-
debug_object_deactivate
139
-
-------------------------
144
+
145
+
.. kernel-doc:: lib/debugobjects.c
146
+
:functions: debug_object_deactivate
140
147
141
148
This function is called whenever the deactivation function of a real
142
149
object is called.
···
149
154
When the deactivation is legitimate, then the state of the associated
150
155
tracker object is set to ODEBUG_STATE_INACTIVE.
151
156
152
-
debug_object_destroy
153
-
----------------------
157
+
.. kernel-doc:: lib/debugobjects.c
158
+
:functions: debug_object_destroy
154
159
155
160
This function is called to mark an object destroyed. This is useful to
156
161
prevent the usage of invalid objects, which are still available in
···
168
173
When the destruction is legitimate, then the state of the associated
169
174
tracker object is set to ODEBUG_STATE_DESTROYED.
170
175
171
-
debug_object_free
172
-
-------------------
176
+
.. kernel-doc:: lib/debugobjects.c
177
+
:functions: debug_object_free
173
178
174
179
This function is called before an object is freed.
175
180
···
184
189
Note that debug_object_free removes the object from the tracker. Later
185
190
usage of the object is detected by the other debug checks.
186
191
187
-
debug_object_assert_init
188
-
---------------------------
192
+
193
+
.. kernel-doc:: lib/debugobjects.c
194
+
:functions: debug_object_assert_init
189
195
190
196
This function is called to assert that an object has been initialized.
191
197