Skip to contentSkip to conversation

arch/x86/mm: fix some kernel-doc warnings

PATCH In review Wanpeng Li 2 participants 2 messages Jun 10, 2012 – Jun 11, 2012

Subsystems (2)
x86 x86 MM
lore
Share & tools
lore

Wanpeng Li

author
#0 lore raw

PATCH 1/1 arch/x86/mm: fix some kernel-doc warnings

From: Wanpeng Li <[email protected]>

Fix kernel-doc warnings in arch/x86/mm/ioremap.c and arch/x86/mm/pageattr.c, just like this one:

Warning(arch/x86/mm/ioremap.c:204): No description found for parameter 'phys_addr' Warning(arch/x86/mm/ioremap.c:204): Excess function parameter 'offset' description in 'ioremap_nocache'

Signed-off-by Wanpeng Li <[email protected]>
---
 arch/x86/mm/ioremap.c  |    4 ++--
 arch/x86/mm/pageattr.c |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)
arch/x86/mm/ioremap.c +2 -2
index be1ef57..78fe3f1 100644
@@ -180,7 +180,7 @@ err_free_memtype:
 
 /**
  * ioremap_nocache     -   map bus memory into CPU space
- * @offset:    bus address of the memory
+ * @phys_addr:    bus address of the memory
  * @size:      size of the resource to map
  *
  * ioremap_nocache performs a platform specific sequence of operations to

@@ -217,7 +217,7 @@ EXPORT_SYMBOL(ioremap_nocache);
 
 /**
  * ioremap_wc	-	map memory into CPU space write combined
- * @offset:	bus address of the memory
+ * @phys_addr:	bus address of the memory
  * @size:	size of the resource to map
  *
  * This version of ioremap ensures that the memory is marked write combining.
arch/x86/mm/pageattr.c +1 -1
index e1ebde3..a718e0d 100644
@@ -122,7 +122,7 @@ within(unsigned long addr, unsigned long start, unsigned long end)
 
 /**
  * clflush_cache_range - flush a cache range with clflush
- * @addr:	virtual start address
+ * @vaddr:	virtual start address
  * @size:	number of bytes to flush
  *
  * clflush is an unordered instruction which needs fencing with mfence
Signature · 1 line
1.7.9.5
#1 lore raw

[tip:x86/urgent] x86/mm: Fix some kernel-doc warnings

Commit-ID:  9efc31b81d740487fd204fade0913ffa8cc97fc3
Gitweb:     http://git.kernel.org/tip/9efc31b81d740487fd204fade0913ffa8cc97fc3
Author:     Wanpeng Li <[email protected]>
AuthorDate: Sun, 10 Jun 2012 10:50:52 +0800
Committer:  Ingo Molnar <[email protected]>
CommitDate: Mon, 11 Jun 2012 10:54:45 +0200

x86/mm: Fix some kernel-doc warnings

Fix kernel-doc warnings in arch/x86/mm/ioremap.c and arch/x86/mm/pageattr.c, just like this one:

Warning(arch/x86/mm/ioremap.c:204):
No description found for parameter 'phys_addr'
Warning(arch/x86/mm/ioremap.c:204):
Excess function parameter 'offset' description in 'ioremap_nocache'

Signed-off-by Wanpeng Li <[email protected]>
Cc Gavin Shan <[email protected]>
Cc Wanpeng Li <[email protected]>
Link http://lkml.kernel.org/r/[email protected] open here
Signed-off-by Ingo Molnar <[email protected]>
---
 arch/x86/mm/ioremap.c  |    4 ++--
 arch/x86/mm/pageattr.c |    2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)
arch/x86/mm/ioremap.c +2 -2
index be1ef57..78fe3f1 100644
@@ -180,7 +180,7 @@ err_free_memtype:
 
 /**
  * ioremap_nocache     -   map bus memory into CPU space
- * @offset:    bus address of the memory
+ * @phys_addr:    bus address of the memory
  * @size:      size of the resource to map
  *
  * ioremap_nocache performs a platform specific sequence of operations to

@@ -217,7 +217,7 @@ EXPORT_SYMBOL(ioremap_nocache);
 
 /**
  * ioremap_wc	-	map memory into CPU space write combined
- * @offset:	bus address of the memory
+ * @phys_addr:	bus address of the memory
  * @size:	size of the resource to map
  *
  * This version of ioremap ensures that the memory is marked write combining.
arch/x86/mm/pageattr.c +1 -1
index e1ebde3..a718e0d 100644
@@ -122,7 +122,7 @@ within(unsigned long addr, unsigned long start, unsigned long end)
 
 /**
  * clflush_cache_range - flush a cache range with clflush
- * @addr:	virtual start address
+ * @vaddr:	virtual start address
  * @size:	number of bytes to flush
  *
  * clflush is an unordered instruction which needs fencing with mfence