[PATCH] ARM: at91/Documentation: add a README for Atmel SoCs

[Olof Johansson]

On Fri, Jan 09, 2015 at 02:20:31PM +0100, Nicolas Ferre wrote:
> Add a README file to describe Atmel SoCs (aka AT91) support in Mainline Linux:
> - SoC list + datasheet web links
> - Basic but useful information
> - Device Tree conventions and Work In Progress statement.
> 
> Signed-off-by: Nicolas Ferre <nicolas.ferre at atmel.com>
> Cc: ARM Maintainers <arm at kernel.org>

Acked-by: Olof Johansson <olof at lixom.net>

With the understanding that:

> +Device Tree for AT91 SoCs and boards
> +------------------------------------
> +All AT91 SoCs are converted to Device Tree. Since Linux 3.19, these products
> +must use this method to boot the Linux kernel.
> +
> +Work In Progress statement:
> +Device Tree files and Device Tree bindings that apply to AT91 SoCs and boards are
> +considered as "Unstable". To be completely clear, any at91 binding can change at
> +any time. So, be sure to use a Device Tree Binary and a Kernel Image generated from
> +the same source tree.
> +Please refer to the Documentation/devicetree/bindings/ABI.txt file for a
> +definition of a "Stable" binding/ABI.
> +This statement will be removed by AT91 MAINTAINERS when appropriated.

While this statement is here, at the end of the day if you break a user
you're responsible for fixing them. I.e. if a tree falls in the forest
and nobody notices, then so be it.

But you can't break existing users and point to this and get away with
it. However, hopefully based on this doc users will go with practices
that means that you can revise bindings if you have to.


-Olof