[PATCH v2 1/1] Documentation: dt-bindings: Explain order in patch series

[PATCH v2 1/1] Documentation: dt-bindings: Explain order in patch series

[Javier Martinez Canillas]

When posting a patch series that includes both code implementing a
Device Tree binding and its associated documentation, the DT docs
should come in the series before the implementation.

This not only avoids checkpatch.pl to complain about undocumented
bindings but also makes the review process easier.

Document this convention since it may not be obvious.

Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>
---

Changes since v1:
 - Small typo error, sorry for the noise.

 Documentation/devicetree/bindings/submitting-patches.txt | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
index 042a027..b7ba01a 100644
--- a/Documentation/devicetree/bindings/submitting-patches.txt
+++ b/Documentation/devicetree/bindings/submitting-patches.txt
@@ -12,6 +12,9 @@ I. For patch submitters
 
        devicetree@vger.kernel.org
 
+  3) The Documentation/ portion of the patch should come in the series before
+     the code implementing the binding.
+
 II. For kernel maintainers
 
   1) If you aren't comfortable reviewing a given binding, reply to it and ask
-- 
2.1.0

Re: [PATCH v2 1/1] Documentation: dt-bindings: Explain order in patch series

[Mark Rutland]

On Thu, Oct 09, 2014 at 07:24:07PM +0100, Javier Martinez Canillas wrote:
> When posting a patch series that includes both code implementing a
> Device Tree binding and its associated documentation, the DT docs
> should come in the series before the implementation.
> 
> This not only avoids checkpatch.pl to complain about undocumented
> bindings but also makes the review process easier.
> 
> Document this convention since it may not be obvious.
> 
> Signed-off-by: Javier Martinez Canillas <javier.martinez@collabora.co.uk>

Following the discussion around [1], this makes sense to me, so:

Acked-by: Mark Rutland <mark.rutland@arm.com>

Mark.

[1] http://lkml.kernel.org/r/54356666.4090003@collabora.co.uk

> ---
> 
> Changes since v1:
>  - Small typo error, sorry for the noise.
> 
>  Documentation/devicetree/bindings/submitting-patches.txt | 3 +++
>  1 file changed, 3 insertions(+)
> 
> diff --git a/Documentation/devicetree/bindings/submitting-patches.txt b/Documentation/devicetree/bindings/submitting-patches.txt
> index 042a027..b7ba01a 100644
> --- a/Documentation/devicetree/bindings/submitting-patches.txt
> +++ b/Documentation/devicetree/bindings/submitting-patches.txt
> @@ -12,6 +12,9 @@ I. For patch submitters
>  
>         devicetree@vger.kernel.org
>  
> +  3) The Documentation/ portion of the patch should come in the series before
> +     the code implementing the binding.
> +
>  II. For kernel maintainers
>  
>    1) If you aren't comfortable reviewing a given binding, reply to it and ask
> -- 
> 2.1.0
> 
> 

Re: [PATCH v2 1/1] Documentation: dt-bindings: Explain order in patch series

[Jonathan Corbet]

On Tue, 14 Oct 2014 10:25:52 +0100
Mark Rutland <mark.rutland@arm.com> wrote:

> Following the discussion around [1], this makes sense to me, so:
> 
> Acked-by: Mark Rutland <mark.rutland@arm.com>

Applied to my shiny new docs tree in case nobody else grabs it.

jon

Re: [PATCH v2 1/1] Documentation: dt-bindings: Explain order in patch series

[Javier Martinez Canillas]

Hello Jon,

On 10/20/2014 05:49 PM, Jonathan Corbet wrote:
> On Tue, 14 Oct 2014 10:25:52 +0100
> Mark Rutland <mark.rutland@arm.com> wrote:
> 
>> Following the discussion around [1], this makes sense to me, so:
>> 
>> Acked-by: Mark Rutland <mark.rutland@arm.com>
> 
> Applied to my shiny new docs tree in case nobody else grabs it.
> 
> jon
> 

Thanks a lot for picking this

Javier