summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDu, Changbin <changbin.du@intel.com>2016-05-19 20:09:38 -0400
committerLinus Torvalds <torvalds@linux-foundation.org>2016-05-19 22:12:14 -0400
commit8bad1cd0e1edd124c0f05f925762ef84e6047586 (patch)
treeefdc6895f389693120735b12c7220a7c65bc7d30
parentd99b1d8912654c4bdeb51063d2e934afc2372cc2 (diff)
Documentation: update debugobjects doc
Update documentation creangponding to change(debugobjects: make fixup functions return bool instead of int). Signed-off-by: Du, Changbin <changbin.du@intel.com> Cc: Jonathan Corbet <corbet@lwn.net> Cc: Josh Triplett <josh@kernel.org> Cc: Steven Rostedt <rostedt@goodmis.org> Cc: Thomas Gleixner <tglx@linutronix.de> Cc: Tejun Heo <tj@kernel.org> Cc: Christian Borntraeger <borntraeger@de.ibm.com> Signed-off-by: Andrew Morton <akpm@linux-foundation.org> Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
-rw-r--r--Documentation/DocBook/debugobjects.tmpl26
1 files changed, 14 insertions, 12 deletions
diff --git a/Documentation/DocBook/debugobjects.tmpl b/Documentation/DocBook/debugobjects.tmpl
index 24979f691e3e..7e4f34fde697 100644
--- a/Documentation/DocBook/debugobjects.tmpl
+++ b/Documentation/DocBook/debugobjects.tmpl
@@ -316,8 +316,8 @@
316 </itemizedlist> 316 </itemizedlist>
317 </para> 317 </para>
318 <para> 318 <para>
319 The function returns 1 when the fixup was successful, 319 The function returns true when the fixup was successful,
320 otherwise 0. The return value is used to update the 320 otherwise false. The return value is used to update the
321 statistics. 321 statistics.
322 </para> 322 </para>
323 <para> 323 <para>
@@ -341,8 +341,8 @@
341 </itemizedlist> 341 </itemizedlist>
342 </para> 342 </para>
343 <para> 343 <para>
344 The function returns 1 when the fixup was successful, 344 The function returns true when the fixup was successful,
345 otherwise 0. The return value is used to update the 345 otherwise false. The return value is used to update the
346 statistics. 346 statistics.
347 </para> 347 </para>
348 <para> 348 <para>
@@ -359,7 +359,8 @@
359 statically initialized object or not. In case it is it calls 359 statically initialized object or not. In case it is it calls
360 debug_object_init() and debug_object_activate() to make the 360 debug_object_init() and debug_object_activate() to make the
361 object known to the tracker and marked active. In this case 361 object known to the tracker and marked active. In this case
362 the function should return 0 because this is not a real fixup. 362 the function should return false because this is not a real
363 fixup.
363 </para> 364 </para>
364 </sect1> 365 </sect1>
365 366
@@ -376,8 +377,8 @@
376 </itemizedlist> 377 </itemizedlist>
377 </para> 378 </para>
378 <para> 379 <para>
379 The function returns 1 when the fixup was successful, 380 The function returns true when the fixup was successful,
380 otherwise 0. The return value is used to update the 381 otherwise false. The return value is used to update the
381 statistics. 382 statistics.
382 </para> 383 </para>
383 </sect1> 384 </sect1>
@@ -397,8 +398,8 @@
397 </itemizedlist> 398 </itemizedlist>
398 </para> 399 </para>
399 <para> 400 <para>
400 The function returns 1 when the fixup was successful, 401 The function returns true when the fixup was successful,
401 otherwise 0. The return value is used to update the 402 otherwise false. The return value is used to update the
402 statistics. 403 statistics.
403 </para> 404 </para>
404 </sect1> 405 </sect1>
@@ -414,8 +415,8 @@
414 debug bucket. 415 debug bucket.
415 </para> 416 </para>
416 <para> 417 <para>
417 The function returns 1 when the fixup was successful, 418 The function returns true when the fixup was successful,
418 otherwise 0. The return value is used to update the 419 otherwise false. The return value is used to update the
419 statistics. 420 statistics.
420 </para> 421 </para>
421 <para> 422 <para>
@@ -427,7 +428,8 @@
427 case. The fixup function should check if this is a legitimate 428 case. The fixup function should check if this is a legitimate
428 case of a statically initialized object or not. In this case only 429 case of a statically initialized object or not. In this case only
429 debug_object_init() should be called to make the object known to 430 debug_object_init() should be called to make the object known to
430 the tracker. Then the function should return 0 because this is not 431 the tracker. Then the function should return false because this
432 is not
431 a real fixup. 433 a real fixup.
432 </para> 434 </para>
433 </sect1> 435 </sect1>