linux-kernel - [PATCH -mm] fix kgdb kernel-doc

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [day] [month] [year] [list]

Message-Id: <20070728093831.8dff0e15.randy.dunlap@oracle.com>
Date:	Sat, 28 Jul 2007 09:38:31 -0700
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	kgdb-bugreport@...ts.sourceforge.net,
	lkml <linux-kernel@...r.kernel.org>
Cc:	jason.wessel@...driver.com, akpm <akpm@...ux-foundation.org>
Subject: [PATCH -mm] fix kgdb kernel-doc

From: Randy Dunlap <randy.dunlap@...cle.com>

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 <randy.dunlap@...cle.com>
---
 Documentation/DocBook/kgdb.tmpl |    4 +++-
 include/linux/kgdb.h            |    4 ++++
 2 files changed, 7 insertions(+), 1 deletion(-)

--- linux-2.6.23-rc1-mm1.orig/Documentation/DocBook/kgdb.tmpl
+++ linux-2.6.23-rc1-mm1/Documentation/DocBook/kgdb.tmpl
@@ -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>
--- linux-2.6.23-rc1-mm1.orig/include/linux/kgdb.h
+++ linux-2.6.23-rc1-mm1/include/linux/kgdb.h
@@ -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
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html
Please read the FAQ at  http://www.tux.org/lkml/