2014-01-16 10:50:39

by Hongbo Zhang

[permalink] [raw]
Subject: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

From: Hongbo Zhang <[email protected]>

Since there are already seven DMA documentations under the top Documentation/,
it is better to create one dedicated directory for them.

Signed-off-by: Hongbo Zhang <[email protected]>
Cc: David S. Miller <[email protected]>
Cc: Richard Henderson <[email protected]>
Cc: Jakub Jelinek <[email protected]>
Cc: James E.J. Bottomley <[email protected]>
Cc: Arthur Kepner <[email protected]>
Cc: [email protected]
Cc: Vinod Koul <[email protected]>
Cc: Pierre Ossman <[email protected]>
Cc: Andy Shevchenko <[email protected]>
---
Documentation/{ => dma}/DMA-API-HOWTO.txt | 0
Documentation/{ => dma}/DMA-API.txt | 0
Documentation/{ => dma}/DMA-ISA-LPC.txt | 0
Documentation/{ => dma}/DMA-attributes.txt | 0
Documentation/{ => dma}/dma-buf-sharing.txt | 0
Documentation/{ => dma}/dmaengine.txt | 0
Documentation/{ => dma}/dmatest.txt | 0
7 files changed, 0 insertions(+), 0 deletions(-)
rename Documentation/{ => dma}/DMA-API-HOWTO.txt (100%)
rename Documentation/{ => dma}/DMA-API.txt (100%)
rename Documentation/{ => dma}/DMA-ISA-LPC.txt (100%)
rename Documentation/{ => dma}/DMA-attributes.txt (100%)
rename Documentation/{ => dma}/dma-buf-sharing.txt (100%)
rename Documentation/{ => dma}/dmaengine.txt (100%)
rename Documentation/{ => dma}/dmatest.txt (100%)

diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/dma/DMA-API-HOWTO.txt
similarity index 100%
rename from Documentation/DMA-API-HOWTO.txt
rename to Documentation/dma/DMA-API-HOWTO.txt
diff --git a/Documentation/DMA-API.txt b/Documentation/dma/DMA-API.txt
similarity index 100%
rename from Documentation/DMA-API.txt
rename to Documentation/dma/DMA-API.txt
diff --git a/Documentation/DMA-ISA-LPC.txt b/Documentation/dma/DMA-ISA-LPC.txt
similarity index 100%
rename from Documentation/DMA-ISA-LPC.txt
rename to Documentation/dma/DMA-ISA-LPC.txt
diff --git a/Documentation/DMA-attributes.txt b/Documentation/dma/DMA-attributes.txt
similarity index 100%
rename from Documentation/DMA-attributes.txt
rename to Documentation/dma/DMA-attributes.txt
diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma/dma-buf-sharing.txt
similarity index 100%
rename from Documentation/dma-buf-sharing.txt
rename to Documentation/dma/dma-buf-sharing.txt
diff --git a/Documentation/dmaengine.txt b/Documentation/dma/dmaengine.txt
similarity index 100%
rename from Documentation/dmaengine.txt
rename to Documentation/dma/dmaengine.txt
diff --git a/Documentation/dmatest.txt b/Documentation/dma/dmatest.txt
similarity index 100%
rename from Documentation/dmatest.txt
rename to Documentation/dma/dmatest.txt
--
1.7.9.5



2014-01-16 10:50:36

by Hongbo Zhang

[permalink] [raw]
Subject: [PATCH resend 2/2] Documentation: update some DMA document texts due to relocation

From: Hongbo Zhang <[email protected]>

Some references to "Documentation/*" in the moved documentations should be
updated to "Documentation/dma/*" accordingly.

Signed-off-by: Hongbo Zhang <[email protected]>
Cc: James E.J. Bottomley <[email protected]>
Cc: Pierre Ossman <[email protected]>
---
Documentation/dma/DMA-API.txt | 6 +++---
Documentation/dma/DMA-ISA-LPC.txt | 2 +-
2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/dma/DMA-API.txt b/Documentation/dma/DMA-API.txt
index e865279..e4dc36c 100644
--- a/Documentation/dma/DMA-API.txt
+++ b/Documentation/dma/DMA-API.txt
@@ -5,7 +5,7 @@

This document describes the DMA API. For a more gentle introduction
of the API (and actual examples) see
-Documentation/DMA-API-HOWTO.txt.
+Documentation/dma/DMA-API-HOWTO.txt.

This API is split into two pieces. Part I describes the API. Part II
describes the extensions to the API for supporting non-consistent
@@ -395,7 +395,7 @@ struct dma_attrs encapsulates a set of "dma attributes". For the
definition of struct dma_attrs see linux/dma-attrs.h.

The interpretation of dma attributes is architecture-specific, and
-each attribute should be documented in Documentation/DMA-attributes.txt.
+each attribute should be documented in Documentation/dma/DMA-attributes.txt.

If struct dma_attrs* is NULL, the semantics of each of these
functions is identical to those of the corresponding function
@@ -408,7 +408,7 @@ for DMA:

#include <linux/dma-attrs.h>
/* DMA_ATTR_FOO should be defined in linux/dma-attrs.h and
- * documented in Documentation/DMA-attributes.txt */
+ * documented in Documentation/dma/DMA-attributes.txt */
...

DEFINE_DMA_ATTRS(attrs);
diff --git a/Documentation/dma/DMA-ISA-LPC.txt b/Documentation/dma/DMA-ISA-LPC.txt
index e767805..e9b7a1c 100644
--- a/Documentation/dma/DMA-ISA-LPC.txt
+++ b/Documentation/dma/DMA-ISA-LPC.txt
@@ -16,7 +16,7 @@ To do ISA style DMA you need to include two headers:
#include <asm/dma.h>

The first is the generic DMA API used to convert virtual addresses to
-physical addresses (see Documentation/DMA-API.txt for details).
+physical addresses (see Documentation/dma/DMA-API.txt for details).

The second contains the routines specific to ISA DMA transfers. Since
this is not present on all platforms make sure you construct your
--
1.7.9.5


2014-01-16 14:29:19

by Andy Shevchenko

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

On Thu, 2014-01-16 at 18:50 +0800, [email protected] wrote:
> From: Hongbo Zhang <[email protected]>
>
> Since there are already seven DMA documentations under the top Documentation/,
> it is better to create one dedicated directory for them.

In case DMA maintainers are okay with that I give my

Acked-by: Andy Shevchenko <[email protected]>

for the dmatest.txt part.

>
> Signed-off-by: Hongbo Zhang <[email protected]>
> Cc: David S. Miller <[email protected]>
> Cc: Richard Henderson <[email protected]>
> Cc: Jakub Jelinek <[email protected]>
> Cc: James E.J. Bottomley <[email protected]>
> Cc: Arthur Kepner <[email protected]>
> Cc: [email protected]
> Cc: Vinod Koul <[email protected]>
> Cc: Pierre Ossman <[email protected]>
> Cc: Andy Shevchenko <[email protected]>
> ---
> Documentation/{ => dma}/DMA-API-HOWTO.txt | 0
> Documentation/{ => dma}/DMA-API.txt | 0
> Documentation/{ => dma}/DMA-ISA-LPC.txt | 0
> Documentation/{ => dma}/DMA-attributes.txt | 0
> Documentation/{ => dma}/dma-buf-sharing.txt | 0
> Documentation/{ => dma}/dmaengine.txt | 0
> Documentation/{ => dma}/dmatest.txt | 0
> 7 files changed, 0 insertions(+), 0 deletions(-)
> rename Documentation/{ => dma}/DMA-API-HOWTO.txt (100%)
> rename Documentation/{ => dma}/DMA-API.txt (100%)
> rename Documentation/{ => dma}/DMA-ISA-LPC.txt (100%)
> rename Documentation/{ => dma}/DMA-attributes.txt (100%)
> rename Documentation/{ => dma}/dma-buf-sharing.txt (100%)
> rename Documentation/{ => dma}/dmaengine.txt (100%)
> rename Documentation/{ => dma}/dmatest.txt (100%)
>
> diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/dma/DMA-API-HOWTO.txt
> similarity index 100%
> rename from Documentation/DMA-API-HOWTO.txt
> rename to Documentation/dma/DMA-API-HOWTO.txt
> diff --git a/Documentation/DMA-API.txt b/Documentation/dma/DMA-API.txt
> similarity index 100%
> rename from Documentation/DMA-API.txt
> rename to Documentation/dma/DMA-API.txt
> diff --git a/Documentation/DMA-ISA-LPC.txt b/Documentation/dma/DMA-ISA-LPC.txt
> similarity index 100%
> rename from Documentation/DMA-ISA-LPC.txt
> rename to Documentation/dma/DMA-ISA-LPC.txt
> diff --git a/Documentation/DMA-attributes.txt b/Documentation/dma/DMA-attributes.txt
> similarity index 100%
> rename from Documentation/DMA-attributes.txt
> rename to Documentation/dma/DMA-attributes.txt
> diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma/dma-buf-sharing.txt
> similarity index 100%
> rename from Documentation/dma-buf-sharing.txt
> rename to Documentation/dma/dma-buf-sharing.txt
> diff --git a/Documentation/dmaengine.txt b/Documentation/dma/dmaengine.txt
> similarity index 100%
> rename from Documentation/dmaengine.txt
> rename to Documentation/dma/dmaengine.txt
> diff --git a/Documentation/dmatest.txt b/Documentation/dma/dmatest.txt
> similarity index 100%
> rename from Documentation/dmatest.txt
> rename to Documentation/dma/dmatest.txt

--
Andy Shevchenko <[email protected]>
Intel Finland Oy

2014-01-16 17:01:39

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

On Thu, Jan 16, 2014 at 06:50:04PM +0800, [email protected] wrote:
> From: Hongbo Zhang <[email protected]>
>
> Since there are already seven DMA documentations under the top Documentation/,
> it is better to create one dedicated directory for them.

Well the problem is that not everything is same. Some of these mean how to use
dma mapping API, couple are related to dmaengine, so clubing everything into
"dma" doesnt sound right to me!

--
~Vinod
>
> Signed-off-by: Hongbo Zhang <[email protected]>
> Cc: David S. Miller <[email protected]>
> Cc: Richard Henderson <[email protected]>
> Cc: Jakub Jelinek <[email protected]>
> Cc: James E.J. Bottomley <[email protected]>
> Cc: Arthur Kepner <[email protected]>
> Cc: [email protected]
> Cc: Vinod Koul <[email protected]>
> Cc: Pierre Ossman <[email protected]>
> Cc: Andy Shevchenko <[email protected]>
> ---
> Documentation/{ => dma}/DMA-API-HOWTO.txt | 0
> Documentation/{ => dma}/DMA-API.txt | 0
> Documentation/{ => dma}/DMA-ISA-LPC.txt | 0
> Documentation/{ => dma}/DMA-attributes.txt | 0
> Documentation/{ => dma}/dma-buf-sharing.txt | 0
> Documentation/{ => dma}/dmaengine.txt | 0
> Documentation/{ => dma}/dmatest.txt | 0
> 7 files changed, 0 insertions(+), 0 deletions(-)
> rename Documentation/{ => dma}/DMA-API-HOWTO.txt (100%)
> rename Documentation/{ => dma}/DMA-API.txt (100%)
> rename Documentation/{ => dma}/DMA-ISA-LPC.txt (100%)
> rename Documentation/{ => dma}/DMA-attributes.txt (100%)
> rename Documentation/{ => dma}/dma-buf-sharing.txt (100%)
> rename Documentation/{ => dma}/dmaengine.txt (100%)
> rename Documentation/{ => dma}/dmatest.txt (100%)
>
> diff --git a/Documentation/DMA-API-HOWTO.txt b/Documentation/dma/DMA-API-HOWTO.txt
> similarity index 100%
> rename from Documentation/DMA-API-HOWTO.txt
> rename to Documentation/dma/DMA-API-HOWTO.txt
> diff --git a/Documentation/DMA-API.txt b/Documentation/dma/DMA-API.txt
> similarity index 100%
> rename from Documentation/DMA-API.txt
> rename to Documentation/dma/DMA-API.txt
> diff --git a/Documentation/DMA-ISA-LPC.txt b/Documentation/dma/DMA-ISA-LPC.txt
> similarity index 100%
> rename from Documentation/DMA-ISA-LPC.txt
> rename to Documentation/dma/DMA-ISA-LPC.txt
> diff --git a/Documentation/DMA-attributes.txt b/Documentation/dma/DMA-attributes.txt
> similarity index 100%
> rename from Documentation/DMA-attributes.txt
> rename to Documentation/dma/DMA-attributes.txt
> diff --git a/Documentation/dma-buf-sharing.txt b/Documentation/dma/dma-buf-sharing.txt
> similarity index 100%
> rename from Documentation/dma-buf-sharing.txt
> rename to Documentation/dma/dma-buf-sharing.txt
> diff --git a/Documentation/dmaengine.txt b/Documentation/dma/dmaengine.txt
> similarity index 100%
> rename from Documentation/dmaengine.txt
> rename to Documentation/dma/dmaengine.txt
> diff --git a/Documentation/dmatest.txt b/Documentation/dma/dmatest.txt
> similarity index 100%
> rename from Documentation/dmatest.txt
> rename to Documentation/dma/dmatest.txt
> --
> 1.7.9.5
>
>
>

--

2014-01-18 17:56:41

by Rob Landley

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

On 01/16/14 04:50, [email protected] wrote:
> From: Hongbo Zhang <[email protected]>
>
> Since there are already seven DMA documentations under the top Documentation/,
> it is better to create one dedicated directory for them.
>
> Signed-off-by: Hongbo Zhang <[email protected]>
> Cc: David S. Miller <[email protected]>
> Cc: Richard Henderson <[email protected]>
> Cc: Jakub Jelinek <[email protected]>
> Cc: James E.J. Bottomley <[email protected]>
> Cc: Arthur Kepner <[email protected]>
> Cc: [email protected]
> Cc: Vinod Koul <[email protected]>
> Cc: Pierre Ossman <[email protected]>
> Cc: Andy Shevchenko <[email protected]>

If the DMA guys merge this before I do, I note that it needs a 00-INDEX
file for the new directory. (Otherwise I can add that when I forward it.)

Acked-by: Rob Landley <[email protected]>

Rob

2014-01-18 17:59:23

by Rob Landley

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

On 01/16/14 09:59, Vinod Koul wrote:
> On Thu, Jan 16, 2014 at 06:50:04PM +0800, [email protected] wrote:
>> From: Hongbo Zhang <[email protected]>
>>
>> Since there are already seven DMA documentations under the top Documentation/,
>> it is better to create one dedicated directory for them.
>
> Well the problem is that not everything is same. Some of these mean how to use
> dma mapping API, couple are related to dmaengine, so clubing everything into
> "dma" doesnt sound right to me!

Putting everything in the world in the top level directory isn't all
flowers and kittens either.

Where would be a _better_ place to move one of those files to?

Rob

2014-01-20 05:30:59

by Vinod Koul

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma

On Sat, Jan 18, 2014 at 11:59:13AM -0600, Rob Landley wrote:
> On 01/16/14 09:59, Vinod Koul wrote:
> >On Thu, Jan 16, 2014 at 06:50:04PM +0800, [email protected] wrote:
> >>From: Hongbo Zhang <[email protected]>
> >>
> >>Since there are already seven DMA documentations under the top Documentation/,
> >>it is better to create one dedicated directory for them.
> >
> >Well the problem is that not everything is same. Some of these mean how to use
> >dma mapping API, couple are related to dmaengine, so clubing everything into
> >"dma" doesnt sound right to me!
>
> Putting everything in the world in the top level directory isn't all
> flowers and kittens either.
>
> Where would be a _better_ place to move one of those files to?
As pointed mostly things dma* are dma-mapping and dmaengine, so would apt
that we move to two folders, unless i overlooked and assumed everything else is
dma-mapping!

--
~Vinod

2014-01-20 09:13:19

by Hongbo Zhang

[permalink] [raw]
Subject: Re: [PATCH resend 1/2] Documentation: move all DMA documentations into Documentaion/dma


On 01/20/2014 12:29 PM, Vinod Koul wrote:
> On Sat, Jan 18, 2014 at 11:59:13AM -0600, Rob Landley wrote:
>> On 01/16/14 09:59, Vinod Koul wrote:
>>> On Thu, Jan 16, 2014 at 06:50:04PM +0800, [email protected] wrote:
>>>> From: Hongbo Zhang <[email protected]>
>>>>
>>>> Since there are already seven DMA documentations under the top Documentation/,
>>>> it is better to create one dedicated directory for them.
>>> Well the problem is that not everything is same. Some of these mean how to use
>>> dma mapping API, couple are related to dmaengine, so clubing everything into
>>> "dma" doesnt sound right to me!
>> Putting everything in the world in the top level directory isn't all
>> flowers and kittens either.
>>
>> Where would be a _better_ place to move one of those files to?
> As pointed mostly things dma* are dma-mapping and dmaengine, so would apt
> that we move to two folders, unless i overlooked and assumed everything else is
> dma-mapping!

Understand your concern, dma-mapping and dmaengine are different, but
they are all about dma, a general dma folder can include all dma related
files. An example is Documentation/power, so many kinds of power related
files go there.
Anyway, this is my point, it is up to you maintainers.

> --
> ~Vinod
>
>