[elbe-devel] [PATCH v3 03/16] schema: copy_to_patition, set_partition_type: Add attributes

[Bastian Germann]

Am 23.09.22 um 16:03 schrieb Viraj Shah:
> * Add missing attribute for documentation and rewrite documentation
> of finetuning actions copy_to_partition, set_partition_type.
> * Replace tabs with spaces.

Please fix the indentation to add two spaces for each level, also for the text within documentation elements.

> Signed-off-by: Viraj Shah <viraj.shah at linutronix.de>
> ---
>   schema/dbsfed.xsd | 48 ++++++++++++++++++++++++++++++++++++-----------
>   1 file changed, 37 insertions(+), 11 deletions(-)
> 
> diff --git a/schema/dbsfed.xsd b/schema/dbsfed.xsd
> index 495ed2665..232b1961d 100644
> --- a/schema/dbsfed.xsd
> +++ b/schema/dbsfed.xsd
> @@ -2422,29 +2422,55 @@
>     <complexType name="copy_to_partition">
>       <annotation>
>         <documentation>
> -        Attribute 'part' describes the partition to be mounted (nr).
> -	The value of the tag describes the filename where the artifact shall
> -	be copied to, onto the filesystem, after it has been mounted.
> -	Attribute 'artifact' is the artifact name.
> +        It copies the artifact to a given partition that will be
> +        mounted.
> +        Please note that this element's value is destination's path in "part"
> +        partition.
>         </documentation>
>       </annotation>
>       <simpleContent>
>         <extension base="rfs:string">
> -        <attribute name="part" type="integer" use="required" />
> -        <attribute name="artifact" type="string" use="required" />
> +        <attribute name="part" type="integer" use="required">
> +         <annotation>
> +          <documentation>
> +          Describes the partition that the required file is copied to.

... the partition number ...

> +          </documentation>
> +         </annotation>
> +        </attribute>
> +        <attribute name="artifact" type="string" use="required">
> +         <annotation>
> +          <documentation>
> +          The name of the file that is copied to the destination is termed
> +          as "artifact"
> +          </documentation>
> +         </annotation>
> +        </attribute>
>         </extension>
>       </simpleContent>
>     </complexType>
>     <complexType name="set_partition_type">
>       <annotation>
>         <documentation>
> -        Attribute 'part' describes the partition to be modified (nr).
> -	Attribute 'type' is the numerical partition id, as understood by
> -	fdisk.
> +       Sets the partition type of a particular partition to the specified type
> +       for disk labels.
>         </documentation>
>       </annotation>
> -    <attribute name="part" type="integer" use="required" />
> -    <attribute name="type" type="string" use="required" />
> +    <attribute name="part" type="integer" use="required">
> +     <annotation>
> +      <documentation>
> +        Describes the partition to be modified in integer.

I can see from the schema that this is an integer. What I cannot see is how this integer relates to the partition.
Is it the partition number as understood by fdisk?

> +      </documentation>
> +     </annotation>
> +    </attribute>
> +    <attribute name="type" type="string" use="required">
> +     <annotation>
> +      <documentation>
> +       Describes the numerical partition id, as understood by fdsik.
> +       It is the "partition type" and can be a numerical id or a textual alias
> +       for it. This is why the attribute type is string and not int.

Please remove the last sentence. It is obvious.

> +      </documentation>
> +     </annotation>
> +    </attribute>
>     </complexType>
>     <complexType name="addgroup">
>       <annotation>