fix kgdb kernel-doc
Subsystems (2)
PATCH 1/1 fix kgdb kernel-doc
From: Randy Dunlap <[email protected]>
No kernel-doc comments in this file, although kgdb.tmpl implies that it needs some:
Warning(linux-2.6.23-rc1-mm1//kernel/kgdb.c): no structured comments found
Add kernel-doc notation in kgdb.h for:
Warning(linux-2.6.23-rc1-mm1//include/linux/kgdb.h:225): No description found for parameter 'remove_all_hw_break' Warning(linux-2.6.23-rc1-mm1//include/linux/kgdb.h:225): No description found for parameter 'correct_hw_break'
Signed-off-by Randy Dunlap <[email protected]>
--- Documentation/DocBook/kgdb.tmpl | 4 +++- include/linux/kgdb.h | 4 ++++ 2 files changed, 7 insertions(+), 1 deletion(-)
Documentation/DocBook/kgdb.tmpl +3 -1
@@ -235,7 +235,9 @@ and are optionally implemented. Some functions (with _hw_ in the name) end up being required on arches which use hardware breakpoints. </para> -!Ikernel/kgdb.c +<!-- +X!Ikernel/kgdb.c +--> </chapter> <chapter id="DriverSpecificFunctions"> <title>Driver-Specific Functions</title>
include/linux/kgdb.h +4 -0
@@ -207,6 +207,10 @@ extern int kgdb_arch_remove_breakpoint(u* breakpoint. * @remove_hw_breakpoint: Allow an architecture to specify how to remove a * hardware breakpoint. +* @remove_all_hw_break: Allow an architecture to specify how to remove all +* hardware breakpoints. +* @correct_hw_break: Allow an architecture to specify how to correct the +* hardware debug registers. * * The @shadowth flag is an option to shadow information not retrievable by * gdb otherwise. This is deprecated in favor of a binutils which supports