s1kd-refs: Add new format variables and <fragment>

Added the %code% and %fragment% format variables, and added a new element, <fragment>, to the XML report for references to a fragment (such as referredFragment, hotspots or CSNs).
kibook · Oct 10, 2024 · 1924bb0 · 1924bb0
1 parent 200a63e
commit 1924bb0
Show file tree

Hide file tree

Showing 4 changed files with 102 additions and 87 deletions.
diff --git a/tools/s1kd-refs/README.md b/tools/s1kd-refs/README.md
@@ -149,9 +149,14 @@ This allows you to:
     Specify a custom format for printed references. \<fmt\> is a format
     string, where the following variables can be given:
 
+      - %code% - The code of the reference.
+
       - %file% - The filename of the referenced object (nothing is
         printed if no file is matched).
 
+      - %fragment% - The fragment part of a reference (nothing is
+        printed if there is no fragment).
+
       - %line% - The line number where the reference occurs in the
         source.
 

diff --git a/tools/s1kd-refs/doc/DMC-S1KDTOOLS-A-25-00-00-00A-040A-D_EN-CA.XML b/tools/s1kd-refs/doc/DMC-S1KDTOOLS-A-25-00-00-00A-040A-D_EN-CA.XML
@@ -6,10 +6,10 @@
       <dmIdent>
         <dmCode modelIdentCode="S1KDTOOLS" systemDiffCode="A" systemCode="25" subSystemCode="0" subSubSystemCode="0" assyCode="00" disassyCode="00" disassyCodeVariant="A" infoCode="040" infoCodeVariant="A" itemLocationCode="D"/>
         <language languageIsoCode="en" countryIsoCode="CA"/>
-        <issueInfo issueNumber="033" inWork="00"/>
+        <issueInfo issueNumber="033" inWork="01"/>
       </dmIdent>
       <dmAddressItems>
-        <issueDate year="2021" month="04" day="16"/>
+        <issueDate year="2024" month="10" day="10"/>
         <dmTitle>
           <techName>s1kd-refs(1) | s1kd-tools</techName>
         </dmTitle>
@@ -38,8 +38,8 @@
       <qualityAssurance>
         <unverified/>
       </qualityAssurance>
-      <reasonForUpdate>
-        <simplePara>Upissued</simplePara>
+      <reasonForUpdate id="rfu-0001" updateHighlight="1">
+        <simplePara>Add %code% and %fragment% format variables.</simplePara>
       </reasonForUpdate>
     </dmStatus>
   </identAndStatusSection>
@@ -238,9 +238,15 @@
                 <para>Specify a custom format for printed references. &lt;fmt&gt; is a format string, where the following variables can be given:</para>
                 <para>
                   <randomList>
+                    <listItem changeMark="1" changeType="add" reasonForUpdateRefIds="rfu-0001">
+                      <para>%code% - The code of the reference.</para>
+                    </listItem>
                     <listItem>
                       <para>%file% - The filename of the referenced object (nothing is printed if no file is matched).</para>
                     </listItem>
+                    <listItem changeMark="1" changeType="add" reasonForUpdateRefIds="rfu-0001">
+                      <para>%fragment% - The fragment part of a reference (nothing is printed if there is no fragment).</para>
+                    </listItem>
                     <listItem>
                       <para>%line% - The line number where the reference occurs in the source.</para>
                     </listItem>

diff --git a/tools/s1kd-refs/doc/s1kd-refs.1 b/tools/s1kd-refs/doc/s1kd-refs.1
@@ -1,6 +1,6 @@
 .\" Automatically generated by Pandoc 2.0.6
 .\"
-.TH "s1kd\-refs" "1" "2021\-04\-16" "" "s1kd\-tools"
+.TH "s1kd\-refs" "1" "2024\-10\-10" "" "s1kd\-tools"
 .hy
 .SH NAME
 .PP
@@ -203,9 +203,14 @@ Specify a custom format for printed references.
 <fmt> is a format string, where the following variables can be given:
 .RS
 .IP \[bu] 2
+%code% \- The code of the reference.
+.IP \[bu] 2
 %file% \- The filename of the referenced object (nothing is printed if
 no file is matched).
 .IP \[bu] 2
+%fragment% \- The fragment part of a reference (nothing is printed if
+there is no fragment).
+.IP \[bu] 2
 %line% \- The line number where the reference occurs in the source.
 .IP \[bu] 2
 %ref% \- The reference.