[elbe-devel] [PATCH v3 05/16] schema: img_convert: Add attributes for documentation

[Bastian Germann]

Subject should say: Add documentation for attributes

Am 23.09.22 um 16:03 schrieb Viraj Shah:
> * Add missing attributes for documentation of "img_convert" finetuning action.
> * Fix indentation.
> 
> Signed-off-by: Viraj Shah <viraj.shah at linutronix.de>
> ---
>   schema/dbsfed.xsd | 36 ++++++++++++++++++++++++++++--------
>   1 file changed, 28 insertions(+), 8 deletions(-)
> 
> diff --git a/schema/dbsfed.xsd b/schema/dbsfed.xsd
> index b20322e01..8b56c3775 100644
> --- a/schema/dbsfed.xsd
> +++ b/schema/dbsfed.xsd
> @@ -2508,18 +2508,38 @@
>     <complexType name="img_convert">
>       <annotation>
>         <documentation>
> -        Describe the Image to be converted.
> -	The value of the tag describes the filename of the source Imagefile.
> -	The dst attribute the destination filename, and the fmt attribute is
> -	the format. (See 'qemu-img --help' for a list of possible formats)
> -	The Image is per default compressed with gzip afterwards.
> +       Gives an opportunity to convert the image to a specific format with
> +       or without sources. The Image is per default compressed with gzip

Please remove "with or without sources". This does not make sense.

per default -> by default

> +       afterwards.
> +       The value of the tag describes the name of the image.
>         </documentation>
>       </annotation>
>       <simpleContent>
>         <extension base="rfs:string">
> -        <attribute name="dst" type="string" use="required" />
> -        <attribute name="fmt" type="string" use="required" />
> -        <attribute name="keep_src" type="boolean" use="optional" />
> +        <attribute name="dst" type="string" use="required">
> +         <annotation>
> +         <documentation>
> +          Describes the filename of the converted image file.
> +          </documentation>
> +         </annotation>
> +        </attribute>
> +        <attribute name="fmt" type="string" use="required">
> +        <annotation>
> +         <documentation>
> +          Describes the format in which the image file needs to be

Grammar: Describes the format which the image file needs to be converted to.

> +          converted. Please check supported formats section in
> +          "qemu-img --help".
> +          </documentation>
> +         </annotation>
> +        </attribute>
> +        <attribute name="keep_src" type="boolean" use="optional">
> +        <annotation>
> +         <documentation>
> +          Describes if the converted image needs to have sources
> +          in it using a boolean value.

No. Use this:

If set to 'true' the original image file is kept.

> +          </documentation>
> +         </annotation>
> +        </attribute>
>         </extension>
>       </simpleContent>
>     </complexType>