Skip to contentSkip to conversation

atomic_32.h: fix kernel-doc warnings

PATCH In review Randy Dunlap 1 participant 2 messages Jun 14, 2009

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 atomic_32.h: fix kernel-doc warnings

From: Randy Dunlap <[email protected]>

Fix kernel-doc warnings in atomic_32.h:

Warning(arch/x86/include/asm/atomic_32.h:265): No description found for parameter 'ptr' Warning(arch/x86/include/asm/atomic_32.h:265): Excess function parameter 'v' description in '__atomic64_read' Warning(arch/x86/include/asm/atomic_32.h:305): Excess function parameter 'old_val' description in 'atomic64_xchg'

---
 arch/x86/include/asm/atomic_32.h |    3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)
arch/x86/include/asm/atomic_32.h +1 -2
@@ -257,7 +257,7 @@ typedef struct {
 
 /**
  * atomic64_read - read atomic64 variable
- * @v: pointer of type atomic64_t
+ * @ptr: pointer of type atomic64_t
  *
  * Atomically reads the value of @v.
  * Doesn't imply a read memory barrier.
@@ -294,7 +294,6 @@ atomic64_cmpxchg(atomic64_t *ptr, unsign
  * atomic64_xchg - xchg atomic64 variable
  * @ptr:      pointer to type atomic64_t
  * @new_val:  value to assign
- * @old_val:  old value that was there
  *
  * Atomically xchgs the value of @ptr to @new_val and returns
  * the old value.
#1 lore raw

[tip:x86/urgent] x86: atomic_32.h: Fix kernel-doc warnings

Commit-ID:  46e443283891dbd45fba7fa037baab831f5d8f3f
Gitweb:     http://git.kernel.org/tip/46e443283891dbd45fba7fa037baab831f5d8f3f
Author:     Randy Dunlap <[email protected]>
AuthorDate: Sat, 13 Jun 2009 20:00:54 -0700
Committer:  Ingo Molnar <[email protected]>
CommitDate: Sun, 14 Jun 2009 09:06:29 +0200

x86: atomic_32.h: Fix kernel-doc warnings

Fix kernel-doc warnings in atomic_32.h:

Warning(arch/x86/include/asm/atomic_32.h:265): No description found for parameter 'ptr' Warning(arch/x86/include/asm/atomic_32.h:265): Excess function parameter 'v' description in '__atomic64_read' Warning(arch/x86/include/asm/atomic_32.h:305): Excess function parameter 'old_val' description in 'atomic64_xchg'

LKML-Reference: <[email protected]>

---
 arch/x86/include/asm/atomic_32.h |    3 +--
 1 files changed, 1 insertions(+), 2 deletions(-)
arch/x86/include/asm/atomic_32.h +1 -2
index aff9f1f..a6a4b35 100644
@@ -257,7 +257,7 @@ typedef struct {
 
 /**
  * atomic64_read - read atomic64 variable
- * @v: pointer of type atomic64_t
+ * @ptr: pointer of type atomic64_t
  *
  * Atomically reads the value of @v.
  * Doesn't imply a read memory barrier.
@@ -294,7 +294,6 @@ atomic64_cmpxchg(atomic64_t *ptr, unsigned long long old_val,
  * atomic64_xchg - xchg atomic64 variable
  * @ptr:      pointer to type atomic64_t
  * @new_val:  value to assign
- * @old_val:  old value that was there
  *
  * Atomically xchgs the value of @ptr to @new_val and returns
  * the old value.