s1kd-validate: Add -x (--xml) option

Added a new -x (--xml) option, which outputs an XML report of any errors found. This replaces the old short option for --exclude, which is now -X instead.
kibook · Dec 18, 2024 · 510b9cb · 510b9cb
1 parent 225d841
commit 510b9cb
Show file tree

Hide file tree

Showing 5 changed files with 157 additions and 62 deletions.
diff --git a/tools/s1kd-validate/README.md b/tools/s1kd-validate/README.md
@@ -4,7 +4,7 @@ s1kd-validate - Validate S1000D CSDB objects against their schemas
 
 # SYNOPSIS
 
-    s1kd-validate [-s <path>] [-x <URI>] [-F|-f] [-eloqv^h?]
+    s1kd-validate [-s <path>] [-X <URI>] [-F|-f] [-o|-x] [-elqv^h?]
                   [<object>...]
 
 # DESCRIPTION
@@ -46,10 +46,13 @@ schemas.
     Verbose mode. Success/failure will be explicitly reported on top of
     any errors.
 
-  - \-x, --exclude \<URI\>  
+  - \-X, --exclude \<URI\>  
     Exclude an XML namespace from the validation. Elements in the
     namespace specified by \<URI\> are ignored.
 
+  - \-x, --xml  
+    Output an XML report.
+
   - \-^, --remove-deleted  
     Validate with elements that have a change type of "delete" removed.
 

diff --git a/tools/s1kd-validate/doc/DMC-S1KDTOOLS-A-02-00-00-00A-040A-D_EN-CA.XML b/tools/s1kd-validate/doc/DMC-S1KDTOOLS-A-02-00-00-00A-040A-D_EN-CA.XML
@@ -6,10 +6,10 @@
       <dmIdent>
         <dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="02" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
         <language languageIsoCode="en" countryIsoCode="CA"/>
-        <issueInfo issueNumber="027" inWork="00"/>
+        <issueInfo issueNumber="027" inWork="01"/>
       </dmIdent>
       <dmAddressItems>
-        <issueDate year="2021" month="04" day="16"/>
+        <issueDate year="2024" month="12" day="18"/>
         <dmTitle>
           <techName>s1kd-validate(1) | s1kd-tools</techName>
         </dmTitle>
@@ -38,8 +38,11 @@
       <qualityAssurance>
         <unverified/>
       </qualityAssurance>
-      <reasonForUpdate>
-        <simplePara>Upissued</simplePara>
+      <reasonForUpdate id="rfu-xml-report" updateHighlight="1" updateReasonType="urt02">
+        <simplePara>Add -x (--xml) option.</simplePara>
+      </reasonForUpdate>
+      <reasonForUpdate id="rfu-change-exclude" updateHighlight="1" updateReasonType="urt02">
+        <simplePara>Change --exclude short option to -X.</simplePara>
       </reasonForUpdate>
     </dmStatus>
   </identAndStatusSection>
@@ -52,7 +55,7 @@
       <levelledPara>
         <title>SYNOPSIS</title>
         <para>
-          <verbatimText verbatimStyle="vs24"><![CDATA[s1kd-validate [-s <path>] [-x <URI>] [-F|-f] [-eloqv^h?]
+          <verbatimText verbatimStyle="vs24" changeMark="1" changeType="modify" reasonForUpdateRefIds="rfu-xml-report rfu-change-exclude"><![CDATA[s1kd-validate [-s <path>] [-X <URI>] [-F|-f] [-o|-x] [-elqv^h?]
               [<object>...]]]></verbatimText>
         </para>
       </levelledPara>
@@ -118,12 +121,18 @@
                 <para>Verbose mode. Success/failure will be explicitly reported on top of any errors.</para>
               </listItemDefinition>
             </definitionListItem>
-            <definitionListItem>
-              <listItemTerm>-x, --exclude &lt;URI&gt;</listItemTerm>
+            <definitionListItem changeMark="1" changeType="modify" reasonForUpdateRefIds="rfu-change-exclude">
+              <listItemTerm>-X, --exclude &lt;URI&gt;</listItemTerm>
               <listItemDefinition>
                 <para>Exclude an XML namespace from the validation. Elements in the namespace specified by &lt;URI&gt; are ignored.</para>
               </listItemDefinition>
             </definitionListItem>
+            <definitionListItem changeMark="1" changeType="add" reasonForUpdateRefIds="rfu-xml-report">
+              <listItemTerm>-x, --xml</listItemTerm>
+              <listItemDefinition>
+                <para>Output an XML report.</para>
+              </listItemDefinition>
+            </definitionListItem>
             <definitionListItem>
               <listItemTerm>-^, --remove-deleted</listItemTerm>
               <listItemDefinition>

diff --git a/tools/s1kd-validate/doc/s1kd-validate.1 b/tools/s1kd-validate/doc/s1kd-validate.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.0.6
 .\"
-.TH "s1kd\-validate" "1" "2021\-04\-16" "" "s1kd\-tools"
+.TH "s1kd\-validate" "1" "2024\-12\-18" "" "s1kd\-tools"
 .hy
 .SH NAME
 .PP
@@ -9,7 +9,7 @@ s1kd\-validate \- Validate S1000D CSDB objects against their schemas
 .IP
 .nf
 \f[C]
-s1kd\-validate\ [\-s\ <path>]\ [\-x\ <URI>]\ [\-F|\-f]\ [\-eloqv^h?]
+s1kd\-validate\ [\-s\ <path>]\ [\-X\ <URI>]\ [\-F|\-f]\ [\-o|\-x]\ [\-elqv^h?]
 \ \ \ \ \ \ \ \ \ \ \ \ \ \ [<object>...]
 \f[]
 .fi
@@ -70,12 +70,17 @@ Success/failure will be explicitly reported on top of any errors.
 .RS
 .RE
 .TP
-.B \-x, \-\-exclude <URI>
+.B \-X, \-\-exclude <URI>
 Exclude an XML namespace from the validation.
 Elements in the namespace specified by <URI> are ignored.
 .RS
 .RE
 .TP
+.B \-x, \-\-xml
+Output an XML report.
+.RS
+.RE
+.TP
 .B \-^, \-\-remove\-deleted
 Validate with elements that have a change type of "delete" removed.
 .RS