[PATCH v2 1/3] ASoC: Add json-schema documentation for sound-name-prefix

[Jerome Brunet]

On Thu 02 Sep 2021 at 14:25, Rob Herring <robh at kernel.org> wrote:

> On Thu, Sep 02, 2021 at 02:47:27PM +0200, Jerome Brunet wrote:
>> 
>> On Thu 02 Sep 2021 at 11:23, Sameer Pujar <spujar at nvidia.com> wrote:
>> 
>> > The 'sound-name-prefix' is used to prepend suitable strings to a
>> > component widgets or controls. This is helpful when there are
>> > multiple instances of the same component. Add relevant json-schema
>> > and is inspired from sound-name-prefix.txt documentation.
>> >
>> > Signed-off-by: Sameer Pujar <spujar at nvidia.com>
>> > Cc: Jerome Brunet <jbrunet at baylibre.com>
>> > Cc: Rob Herring <robh+dt at kernel.org>
>> > ---
>> >  .../devicetree/bindings/sound/name-prefix.yaml     | 35 ++++++++++++++++++++++
>> >  1 file changed, 35 insertions(+)
>> >  create mode 100644 Documentation/devicetree/bindings/sound/name-prefix.yaml
>> >
>> > diff --git a/Documentation/devicetree/bindings/sound/name-prefix.yaml b/Documentation/devicetree/bindings/sound/name-prefix.yaml
>> > new file mode 100644
>> > index 00000000..b58cc9e
>> > --- /dev/null
>> > +++ b/Documentation/devicetree/bindings/sound/name-prefix.yaml
>> > @@ -0,0 +1,35 @@
>> > +# SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)
>> > +%YAML 1.2
>> > +---
>> > +$id: http://devicetree.org/schemas/sound/name-prefix.yaml#
>> > +$schema: http://devicetree.org/meta-schemas/core.yaml#
>> > +
>> > +title: Component sound name prefix
>> > +
>> > +maintainers:
>> > +  - Jerome Brunet <jbrunet at baylibre.com>
>> 
>> Since this file is referenced using "AllOf", am I going to be listed as
>> maintainer of all the drivers using the property below ? I'm not sure I
>> want that ... :P
>
> No. That's not how it works. You're maintainer of files that list you as 
> maintainer.

Thanks for clarifying.
You can ignore my comment then Sameer. 

>
>> Maybe it would be better to drop the above ?
>> 
>> > +
>> > +properties:
>> > +  sound-name-prefix:
>> > +    $ref: /schemas/types.yaml#/definitions/string
>> > +    description: |
>> > +      Card implementing the routing property define the connection between
>> > +      audio components as list of string pair. Component using the same
>> > +      sink/source names may use this property to prepend the name of their
>> > +      sinks/sources with the provided string.
>> > +
>> > +additionalProperties: true
>> > +
>> > +examples:
>> > +  - |
>> > +    analog-amplifier at 0 {
>> > +        compatible = "simple-audio-amplifier";
>> > +        sound-name-prefix = "FRONT";
>> > +    };
>> > +
>> > +    analog-amplifier at 1 {
>> > +        compatible = "simple-audio-amplifier";
>> > +        sound-name-prefix = "BACK";
>> > +    };
>> > +
>> > +...
>> 
>>