[PATCH] Documentation: remove deprecated function descriptions

[PATCH] Documentation: remove deprecated function descriptions

[FUJITA Tomonori]

Do we really need to have Documentation/DMA-API.txt and
Documentation/PCI/PCI-DMA-mapping.txt? A single document about DMA API
would be better?

=
From: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Subject: [PATCH] Documentation: remove deprecated function descriptions

dma_sync_single, pci_dma_sync_single, dma_sync_sg, and pci_dma_sync_sg
are deprecated. We should not advertise them.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
---
 Documentation/DMA-API.txt |   28 ----------------------------
 1 files changed, 0 insertions(+), 28 deletions(-)

diff --git a/Documentation/DMA-API.txt b/Documentation/DMA-API.txt
index 5aceb88..bb0e75e 100644
--- a/Documentation/DMA-API.txt
+++ b/Documentation/DMA-API.txt
@@ -364,34 +364,6 @@ API.
 Note: <nents> must be the number you passed in, *not* the number of
 physical entries returned.
 
-void
-dma_sync_single(struct device *dev, dma_addr_t dma_handle, size_t size,
-		enum dma_data_direction direction)
-void
-pci_dma_sync_single(struct pci_dev *hwdev, dma_addr_t dma_handle,
-			   size_t size, int direction)
-void
-dma_sync_sg(struct device *dev, struct scatterlist *sg, int nelems,
-			  enum dma_data_direction direction)
-void
-pci_dma_sync_sg(struct pci_dev *hwdev, struct scatterlist *sg,
-		       int nelems, int direction)
-
-Synchronise a single contiguous or scatter/gather mapping.  All the
-parameters must be the same as those passed into the single mapping
-API.
-
-Notes:  You must do this:
-
-- Before reading values that have been written by DMA from the device
-  (use the DMA_FROM_DEVICE direction)
-- After writing values that will be written to the device using DMA
-  (use the DMA_TO_DEVICE) direction
-- before *and* after handing memory to the device if the memory is
-  DMA_BIDIRECTIONAL
-
-See also dma_map_single().
-
 dma_addr_t
 dma_map_single_attrs(struct device *dev, void *cpu_addr, size_t size,
 		     enum dma_data_direction dir,
-- 
1.5.6.5

Re: [PATCH] Documentation: remove deprecated function descriptions

[David Miller]

From: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Date: Mon, 25 Jan 2010 17:46:14 +0900

> From: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
> Subject: [PATCH] Documentation: remove deprecated function descriptions
> 
> dma_sync_single, pci_dma_sync_single, dma_sync_sg, and pci_dma_sync_sg
> are deprecated. We should not advertise them.
> 
> Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>

Acked-by: David S. Miller <davem@davemloft.net>

Re: [PATCH] Documentation: remove deprecated function descriptions

[Joerg Roedel]

On Mon, Jan 25, 2010 at 05:46:14PM +0900, FUJITA Tomonori wrote:
> Do we really need to have Documentation/DMA-API.txt and
> Documentation/PCI/PCI-DMA-mapping.txt? A single document about DMA API
> would be better?

Agreed. A single point of documentation is a lot better.

	Joerg