[PATCH 3/3] i2c-ocores: add some device tree documentation

[Grant Likely]

On Fri, Dec 24, 2010 at 2:38 AM, Jonas Bonn <jonas at southpole.se> wrote:
>> > +/*
>> > + * Device tree configuration:
>> > + *
>> > + * Required properties:
>> > + * - compatible      : "opencores,i2c-ocores"
>>
>> I assume the i2c-ocore interface could end up changing in the future.
>> This compatible value should have some form of version embedded into
>> it.
>>
>
> Unfortunately, versioning is currently one of OpenCores weak points.
> This driver is based on specification version 0.9 and has implementation
> version 1.16 according to source and SVN revision 76.  I've started an
> internal discussion to try to standardize on something useful, but
> there's no consensus, as of yet.  I could make something up here for the
> compatible value, but I'd rather we find a consistent versioning scheme
> that's tenable long-term.
>
> I guess I'll have to sit on these patches for another cycle while we
> think about this.

I think your suggestion below is fine.  I don't see any reason not to
merge this series in 2.6.38.

>  Of course, if you have any suggestions, let me know;
> looking at other drivers, there doesn't seem to be a canonical way of
> doing this...
>
> Perhaps:  opencores,i2c-cores-0.9-76
> (i.e. {driver}-{spec revision}-{implementation svn rev})

Yes, that sounds appropriate.  For xilinx cores I've pushed for the
full revision in the compatible values.  Newer cores can and should
claim compatibility with an older version that implements the same
interface.  Typically one well known, working version tends to become
the canonical version that newer cores claim compatibility against.

g.