linux-kernel - Re: dma-coherent: add documentation to new interfaces

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>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:	Wed, 30 Jul 2008 14:46:50 +0400
From:	Dmitry Baryshkov <dbaryshkov@...il.com>
To:	Randy Dunlap <randy.dunlap@...cle.com>
Cc:	Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
	jbarnes@...tuousgeek.org, mingo@...e.hu
Subject: Re: dma-coherent: add documentation to new interfaces

On Tue, Jul 29, 2008 at 01:17:57PM -0700, Randy Dunlap wrote:
> On Tue, 29 Jul 2008 03:01:07 GMT Linux Kernel Mailing List wrote:
> 
> > Gitweb:     http://git.kernel.org/git/?p=linux/kernel/git/torvalds/linux-2.6.git;a=commit;h=b6d4f7e3ef25beb8c658c97867d98883e69dc544
> > Commit:     b6d4f7e3ef25beb8c658c97867d98883e69dc544
> > Parent:     8fa8b9fbab90c74139e8e868fe5b30b6a9f6be65
> > Author:     Dmitry Baryshkov <dbaryshkov@...il.com>
> > AuthorDate: Sun Jul 20 15:01:10 2008 +0400
> > Committer:  Ingo Molnar <mingo@...e.hu>
> > CommitDate: Sun Jul 20 21:22:00 2008 +0200
> > 
> >     dma-coherent: add documentation to new interfaces
> 
> Hi,
> Please fix these to be proper kernel-doc notation, as described in
> Documentation/kernel-doc-nano-HOWTO.txt ...

Please consider this patch:

>From 766159161001e2e118cc840e7aca4b8d500b1ebf Mon Sep 17 00:00:00 2001
From: Dmitry Baryshkov <dbaryshkov@...il.com>
Date: Wed, 30 Jul 2008 01:41:58 +0400
Subject: [PATCH] dma-coherent: fix kernel-doc comments

Signed-off-by: Dmitry Baryshkov <dbaryshkov@...il.com>
---
 kernel/dma-coherent.c |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)

diff --git a/kernel/dma-coherent.c b/kernel/dma-coherent.c
index 7517115..9ef28a0 100644
--- a/kernel/dma-coherent.c
+++ b/kernel/dma-coherent.c
@@ -93,7 +93,7 @@ void *dma_mark_declared_memory_occupied(struct device *dev,
 EXPORT_SYMBOL(dma_mark_declared_memory_occupied);
 
 /**
- * Try to allocate memory from the per-device coherent area.
+ * dma_alloc_from_coherent() - try to allocate memory from the per-device coherent area
  *
  * @dev:	device from which we allocate memory
  * @size:	size of requested memory area
@@ -101,11 +101,11 @@ EXPORT_SYMBOL(dma_mark_declared_memory_occupied);
  * @ret:	This pointer will be filled with the virtual address
  * 		to allocated area.
  *
- * This function should be only called from per-arch %dma_alloc_coherent()
+ * This function should be only called from per-arch dma_alloc_coherent()
  * to support allocation from per-device coherent memory pools.
  *
  * Returns 0 if dma_alloc_coherent should continue with allocating from
- * generic memory areas, or !0 if dma_alloc_coherent should return %ret.
+ * generic memory areas, or !0 if dma_alloc_coherent should return @ret.
  */
 int dma_alloc_from_coherent(struct device *dev, ssize_t size,
 				       dma_addr_t *dma_handle, void **ret)
@@ -127,7 +127,7 @@ int dma_alloc_from_coherent(struct device *dev, ssize_t size,
 }
 
 /**
- * Try to free the memory allocated from per-device coherent memory pool.
+ * dma_release_from_coherent() - try to free the memory allocated from per-device coherent memory pool
  * @dev:	device from which the memory was allocated
  * @order:	the order of pages allocated
  * @vaddr:	virtual address of allocated pages
@@ -136,7 +136,7 @@ int dma_alloc_from_coherent(struct device *dev, ssize_t size,
  * coherent memory pool and if so, releases that memory.
  *
  * Returns 1 if we correctly released the memory, or 0 if
- * %dma_release_coherent() should proceed with releasing memory from
+ * dma_release_coherent() should proceed with releasing memory from
  * generic pools.
  */
 int dma_release_from_coherent(struct device *dev, int order, void *vaddr)
-- 
1.5.6.3

-- 
With best wishes
Dmitry

--
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/