Renaming CertLinks to DocLinks since parameters will also use them.

Author: james-ball-qualcomm

arch/csr/misa.yaml

@@ -141,7 +141,7 @@ fields:
       - id: csr.misa.M.disabled
         name: Disabling `misa.M` bit
         description: What happens when you turn off `misa.M`
-        links:
+        doc_links:
           - manual:csr:misa:disabling-extension
     cert-test-procedures:
       - id: csr.misa.M.muldiv_with_M_on&off
@@ -212,7 +212,7 @@ cert-coverage-points:
   - id: csr.misa.disabling_bits
     name: Disabling `misa` bits
     description: What happens when you turn off bits
-    links:
+    doc_links:
       - manual:csr:misa:disabling-extension
 cert-test-procedures:
   - id: csr.misa.off&on

arch/ext/Xmock.yaml

@@ -158,13 +158,13 @@ cert-coverage-points:
   - id: ext.Xmock.cov1
     name: Mock coverage point 1
     description: Let's have fun with the `Xmock` extension
-    links:
+    doc_links:
       - manual:inst:mul:encoding
       - udb:doc:inst:mock
   - id: ext.Xmock.cov2
     name: Mock coverage point 2
     description: And some more fun!
-    links:
+    doc_links:
       - manual:csr:misa:disabling-extension
 cert-test-procedures:
   - id: ext.Xmock.my_first

arch/inst/M/mul.yaml

@@ -74,19 +74,19 @@ cert-coverage-points:
   - id: inst.mul.encoding
     name: Encoding
     description: Encoding of `mul` instruction
-    links:
+    doc_links:
       - manual:inst:mul:encoding
   - id: inst.mul.basic_op
     name: Basic operation
     description: Basic operation of `mul` instruction
-    links:
+    doc_links:
       - manual:inst:mul:operation
   - id: inst.mul.ill_exc_misa_M_disabled
     name: Illegal instruction exception when misa.M is 0
     description: |
       An illegal instruction exception is raised when the instruction is executed
       and `misa.M` is 0.
-    links:
+    doc_links:
       - manual:csr:misa:disabling-extension
 
 cert-test-procedures:

arch/inst/mock.yaml

@@ -65,15 +65,15 @@ cert-coverage-points:
   - id: inst.mock.encoding&basic_op
     name: Encoding and basic operation
     description: Encoding and basic operation for `mock` instruction
-    links:
+    doc_links:
       - manual:inst:mul:encoding
       - udb:doc:inst:mock
   - id: inst.mock.ill_exc_misa_M_disabled
     name: Illegal instruction exception when misa.M is 0
     description: |
       An illegal instruction exception is raised when the instruction is executed
       and `misa.M` is 0.
-    links:
+    doc_links:
       - manual:csr:misa:disabling-extension
       # - idl:code:inst:mock:illegal-inst-exc-misa-disabled
 

backends/portfolio/templates/coverage_points.adoc.erb

@@ -14,7 +14,7 @@ Coverage Points for `<%= nice_name %>`: ::
 | <%= defined?(org) ? anchor_for_udb_cert_cov_pt(org, cp.id) : "" %><%= cp.id %>
 | <%= cp.name %>
 | <%= cp.description %>
-a| <% cp.cert_links.each do |link| -%>
+a| <% cp.doc_links.each do |link| -%>
 * <%= link.to_adoc %>
 <% end # each link -%>
 <% end # each coverage point -%>

lib/arch_obj_models/database_obj.rb

@@ -773,28 +773,37 @@ def description = @data["description"]
   # @return [String] Unique ID of the coverage point
   def id = @data["id"]
 
-  # @return [Array<CertLink>] List of certification point links (cross references)
-  def cert_links
-    return @cert_links unless @cert_links.nil?
+  # @return [Array<DocLink>] List of certification point documentation links
+  def doc_links
+    return @doc_links unless @doc_links.nil?
 
-    @cert_links = []
-    @data["links"]&.each do |link_data|
-      @cert_links << CertLink.new(link_data, @db_obj)
+    @doc_links = []
+    @data["doc_links"]&.each do |link_data|
+      @doc_links << DocLink.new(link_data, @db_obj)
     end
 
-    raise "Missing links for certification coverage point ID '#{id}' of kind #{@db_obj.kind}" if @cert_links.empty?
+    raise "Missing doc_links for certification coverage point ID '#{id}' of kind #{@db_obj.kind}" if @doc_links.empty?
 
-    @cert_links
+    @doc_links
   end
 end
 
-class CertLink
-  # @param data [String] The cross reference link provided in the YAML
+# Used to create links into RISC-V documentation with the following formats:
+#   ISA manuals   manual:ext:<ext-name>:<id>
+#                 manual:inst:<inst-name>:<id>
+#                 manual:csr:<csr-name>:<id>
+#                 manual:csr:<csr-name>:<id>
+# non-ISA system component standards, UDB generated documentation,
+# and regions of Sail/IDL pseudo-code.
+#
+#
+class DocLink
+  # @param data [String] The documentation link provided in the YAML
   def initialize(data, db_obj)
     raise ArgumentError, "Need String but was passed a #{data.class}" unless data.is_a?(String)
     @id = data
 
-    raise ArgumentError, "Missing link to certfication coverage point ID for #{db_obj.name} of kind #{db_obj.kind}" if id.nil?
+    raise ArgumentError, "Missing documentation link for #{db_obj.name} of kind #{db_obj.kind}" if @id.nil?
   end
 
   # @return [String] Unique ID of the linked to coverage point

schemas/schema_defs.json

@@ -279,8 +279,8 @@
         "name": {
           "type": "string"
         },
-        "links": {
-          "description": "Cross reference to UDB documentation, ISA manual, or IDL code",
+        "doc_links": {
+          "description": "Link to UDB documentation, ISA manual, Sail code, or IDL code",
           "type": "array",
           "items": {
             "type": "string"