[elbe-devel] [PATCH v2 03/17] schema: dbsfed.xsd: copy_to_patition, set_partition_type

[Bastian Germann]

Am 30.08.22 um 15:39 schrieb Viraj Shah:
> * Add missing attribute documentation and rewrite documentation
> for finetuning actions copy_to_partition, set_partition_type.
> 
> Signed-off-by: Viraj Shah <viraj.shah at linutronix.de>
> ---
>   schema/dbsfed.xsd | 44 +++++++++++++++++++++++++++++++++-----------
>   1 file changed, 33 insertions(+), 11 deletions(-)
> 
> diff --git a/schema/dbsfed.xsd b/schema/dbsfed.xsd
> index b6c0e1e2e..8f4abc5b4 100644
> --- a/schema/dbsfed.xsd
> +++ b/schema/dbsfed.xsd
> @@ -2420,29 +2420,51 @@
>     <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.
> +	"copy_to_partition" copies artifact to a given partition that will be

artifact -> the artifact

> +	mounted.

Please also note that the element's text is the destination path in the 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>
> +	  "part" describes the partition to which the required file is copied to.

partition which (remove 1st "to").

> +	  </documentation>
> +         </annotation>
> +        </attribute>
> +        <attribute name="artifact" type="string" use="required">
> +	 <annotation>
> +          <documentation>
> +	  The name of the copied file that is copied to the destination is termed

copied file -> file

> +	  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>
> +	"part" describes the partition to be modified in integer.

Please try not to include the described attribute's name in the description.
You can just leave it out: Describes ...

> +      </documentation>
> +     </annotation>
> +    </attribute>
> +    <attribute name="type" type="string" use="required">
> +     <annotation>
> +      <documentation>
> +       "type" describes the numerical partition id, as understood by fdsik.

Same here.

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.

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

I am stopping the review for this series here. I think you got the idea what is required for this task.
Please validate the rest of the series and send a v3.