linux-kernel - [PATCH -next resend] kgdb: fix kernel-docs

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]

Date:	Tue, 04 Nov 2008 14:28:19 -0800
From:	Randy Dunlap <randy.dunlap@...cle.com>
To:	lkml <linux-kernel@...r.kernel.org>,
	kgdb-bugreport@...ts.sourceforge.net
CC:	jason.wessel@...driver.com,
	Stephen Rothwell <sfr@...b.auug.org.au>,
	akpm <akpm@...ux-foundation.org>
Subject: [PATCH -next resend] kgdb: fix kernel-docs

Jason,
This is still needed in linux-next.  Please merge it so that
Stephen picks it up in linux-next.


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

Fix kernel-doc format error in kgdb.h:

linux-next-20081022//include/linux/kgdb.h:308): duplicate section name 'Description'

and fix typos in that file's kernel-doc comments.

Signed-off-by: Randy Dunlap <randy.dunlap@...cle.com>
cc: Jason Wessel <jason.wessel@...driver.com>
---
 include/linux/kgdb.h |   12 +++++-------
 1 file changed, 5 insertions(+), 7 deletions(-)

--- linux-next-20081022.orig/include/linux/kgdb.h
+++ linux-next-20081022/include/linux/kgdb.h
@@ -29,8 +29,7 @@ struct pt_regs;
  *
  *	On some architectures it is required to skip a breakpoint
  *	exception when it occurs after a breakpoint has been removed.
- *	This can be implemented in the architecture specific portion of
- *	for kgdb.
+ *	This can be implemented in the architecture specific portion of kgdb.
  */
 extern int kgdb_skipexception(int exception, struct pt_regs *regs);
 
@@ -42,7 +41,7 @@ extern int kgdb_skipexception(int except
  *
  *	This is usually needed on architectures which support SMP and
  *	KGDB.  This function is called after all the secondary cpus have
- *	been put to a know spin state and the primary CPU has control over
+ *	been put to a known spin state and the primary CPU has control over
  *	KGDB.
  */
 extern void kgdb_post_primary_code(struct pt_regs *regs, int e_vector,
@@ -65,7 +64,7 @@ struct uart_port;
 /**
  *	kgdb_breakpoint - compiled in breakpoint
  *
- *	This will be impelmented a static inline per architecture.  This
+ *	This will be implemented as a static inline per architecture.  This
  *	function is called by the kgdb core to execute an architecture
  *	specific trap to cause kgdb to enter the exception processing.
  *
@@ -190,7 +189,7 @@ kgdb_arch_handle_exception(int vector, i
  *	@flags: Current IRQ state
  *
  *	On SMP systems, we need to get the attention of the other CPUs
- *	and get them be in a known state.  This should do what is needed
+ *	and get them into a known state.  This should do what is needed
  *	to get the other CPUs to call kgdb_wait(). Note that on some arches,
  *	the NMI approach is not used for rounding up all the CPUs. For example,
  *	in case of MIPS, smp_call_function() is used to roundup CPUs. In
@@ -295,8 +294,7 @@ extern int __weak kgdb_mem2hex(char *mem
 extern int __weak kgdb_hex2mem(char *buf, char *mem, int count);
 
 /**
- *      kgdb_ebin2mem - (optional arch override) Copy the binary array
- *     pointed to by buf into mem.
+ *      kgdb_ebin2mem - (optional arch override) Copy binary array from @buf into @mem
  *      @buf: source buffer
  *      @mem: target buffer
  *      @count: number of bytes in mem
--
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/