Skip to content

Command descriptions seem to stop at first non-letter character #19

@tcarmelveilleux

Description

@tcarmelveilleux
  • Found during running Alchemy against OperationalCredentialsCluster after previously doing manual updates
  • Command: ./alchemy zap --specRoot ~/repos/connectedhomeip-spec-tcv/ --sdkRoot ~/repos/connectedhomeip --verbose ../connectedhomeip-spec-tcv/src/service_device_management/OperationalCredentialCluster.adoc

Actual output

Command descriptions stop at the first non-letter character:

+    <command source="client" code="0x0A" name="RemoveFabric" response="NOCResponse" optional="false">
+      <description>This command is used by Administrators to remove a given Fabric and </description>

However the spec text said:

[[ref_RemoveFabric, RemoveFabric]]
=== RemoveFabric Command
This command is used by Administrators to remove a given Fabric and *delete all associated fabric-scoped data*.

Similarly:

-    <command source="client" code="0x0c" name="SetVIDVerificationStatement" isFabricScoped="true" optional="false" apiMaturity="provisional">
-      <description>This command SHALL be used to update any of the accessing fabric's associated VendorID, VidVerificatioNStatement or VVSC (Vendor Verification Signing Certificate).</description>
+    <command source="client" code="0x0C" name="SetVIDVerificationStatement" isFabricScoped="true" optional="true" apiMaturity="provisional">
+      <description>This command SHALL be used to one or more of the following:</description>

but the spec text said:

This command SHALL be used to one or more of the following:

* Update the VendorID associated with an entry in the Fabrics attribute.
* Associate or remove a <<ref_VIDVerificationStatement,VIDVerificationStatement>> associated with an entry in the Fabrics attribute.
* Associate or remove a <<ref_VendorVerificationSigningCertificate,VendorVerificationSigningCertificate (VVSC)>> associated with an entry in the NOCs attribute.

A similar thing was observed for commands with a <<xref,blahblah>> within the first line, which causes the description to stop before <<.

Expected output:

  • Each command's description should preferably not be truncated. For the multi-bullet descriptions, I am not sure what to do, but a generic description would be better than a truncated description.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions