iv/linux
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Documentation: update debugobjects doc

Browse Source 
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>
This commit is contained in:
Du, Changbin 2016-05-19 17:09:38 -07:00 committed by Linus Torvalds
parent d99b1d8912
commit 8bad1cd0e1
1 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Documentation/DocBook/debugobjects.tmpl
View File

@ -316,8 +316,8 @@
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
The function returns 1 when the fixup was successful, The function returns true when the fixup was successful,
otherwise 0. The return value is used to update the otherwise false. The return value is used to update the
statistics. statistics.
</para> </para>
<para> <para>
@ -341,8 +341,8 @@
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
The function returns 1 when the fixup was successful, The function returns true when the fixup was successful,
otherwise 0. The return value is used to update the otherwise false. The return value is used to update the
statistics. statistics.
</para> </para>
<para> <para>
@ -359,7 +359,8 @@
statically initialized object or not. In case it is it calls statically initialized object or not. In case it is it calls
debug_object_init() and debug_object_activate() to make the debug_object_init() and debug_object_activate() to make the
object known to the tracker and marked active. In this case object known to the tracker and marked active. In this case
the function should return 0 because this is not a real fixup. the function should return false because this is not a real
fixup.
</para> </para>
</sect1> </sect1>
@ -376,8 +377,8 @@
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
The function returns 1 when the fixup was successful, The function returns true when the fixup was successful,
otherwise 0. The return value is used to update the otherwise false. The return value is used to update the
statistics. statistics.
</para> </para>
</sect1> </sect1>
@ -397,8 +398,8 @@
</itemizedlist> </itemizedlist>
</para> </para>
<para> <para>
The function returns 1 when the fixup was successful, The function returns true when the fixup was successful,
otherwise 0. The return value is used to update the otherwise false. The return value is used to update the
statistics. statistics.
</para> </para>
</sect1> </sect1>
@ -414,8 +415,8 @@
debug bucket. debug bucket.
</para> </para>
<para> <para>
The function returns 1 when the fixup was successful, The function returns true when the fixup was successful,
otherwise 0. The return value is used to update the otherwise false. The return value is used to update the
statistics. statistics.
</para> </para>
<para> <para>
@ -427,7 +428,8 @@
case. The fixup function should check if this is a legitimate case. The fixup function should check if this is a legitimate
case of a statically initialized object or not. In this case only case of a statically initialized object or not. In this case only
debug_object_init() should be called to make the object known to debug_object_init() should be called to make the object known to
the tracker. Then the function should return 0 because this is not the tracker. Then the function should return false because this
is not
a real fixup. a real fixup.
</para> </para>
</sect1> </sect1>