Created portfolio backend with common tasks.rake code between portfolios. Also created include_erb method in PortfolioDesign that invokes ERB partial templates with a standard set of locals.

Author: james-ball-qualcomm

.github/workflows/pages.yml

@@ -62,19 +62,19 @@ jobs:
       - name: Create RVA20 Profile Release PDF Spec
         run: ./do gen:profile_release_pdf[RVA20]
       - name: Copy RVA20 Profile Release PDF
-        run: cp gen/profile_doc/pdf/RVA20.pdf _site/pdfs/RVA20.pdf
+        run: cp gen/profile/pdf/RVA20.pdf _site/pdfs/RVA20.pdf
       - name: Create RVA22 Profile Release PDF Spec
         run: ./do gen:profile_release_pdf[RVA22]
       - name: Copy RVA22 Profile Release PDF
-        run: cp gen/profile_doc/pdf/RVA22.pdf _site/pdfs/RVA22.pdf
+        run: cp gen/profile/pdf/RVA22.pdf _site/pdfs/RVA22.pdf
       - name: Copy RVA23 Profile Release PDF
-        run: cp gen/profile_doc/pdf/RVA23.pdf _site/pdfs/RVA23.pdf
+        run: cp gen/profile/pdf/RVA23.pdf _site/pdfs/RVA23.pdf
       - name: Copy RVB23 Profile Release PDF
-        run: cp gen/profile_doc/pdf/RVB23.pdf _site/pdfs/RVB23.pdf
+        run: cp gen/profile/pdf/RVB23.pdf _site/pdfs/RVB23.pdf
       - name: Create RVI20 Profile Release PDF Spec
         run: ./do gen:profile_release_pdf[RVI20]
       - name: Copy RVI20 Profile Release PDF
-        run: cp gen/profile_doc/pdf/RVA20.pdf _site/pdfs/RVI20.pdf
+        run: cp gen/profile/pdf/RVA20.pdf _site/pdfs/RVI20.pdf
       - name: Create MC100-32 PDF Spec
         run: ./do gen:proc_crd_pdf[MC100-32]
       - name: Copy MC100-32 PDF

Rakefile

@@ -324,7 +324,7 @@ namespace :test do
     Rake::Task["gen:html"].invoke("generic_rv64")
 
     Rake::Task["#{$root}/gen/crd/pdf/MockProcCertModel.pdf"].invoke
-    Rake::Task["#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"].invoke
+    Rake::Task["#{$root}/gen/profile/pdf/MockProfileRelease.pdf"].invoke
 
     puts
     puts "Regression test PASSED"
@@ -350,7 +350,7 @@ task :portfolios do
   portfolio_start_msg("MockProcCertModel CRD")
   Rake::Task["#{$root}/gen/crd/pdf/MockProcCertModel.pdf"].invoke
   portfolio_start_msg("MockProfileRelease CRD")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/MockProfileRelease.pdf"].invoke
   portfolio_start_msg("MC100-32 CRD")
   Rake::Task["#{$root}/gen/crd/pdf/MC100-32.pdf"].invoke
   portfolio_start_msg("MC100-64 CRD")
@@ -364,15 +364,15 @@ task :portfolios do
   portfolio_start_msg("MC300-64 CRD")
   Rake::Task["#{$root}/gen/crd/pdf/MC300-64.pdf"].invoke
   portfolio_start_msg("RVI20 Profile Release")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/RVI20.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/RVI20.pdf"].invoke
   portfolio_start_msg("RVA20 Profile Release")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/RVA20.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/RVA20.pdf"].invoke
   portfolio_start_msg("RVA22 Profile Release")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/RVA22.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/RVA22.pdf"].invoke
   portfolio_start_msg("RVA23 Profile Release")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/RVA23.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/RVA23.pdf"].invoke
   portfolio_start_msg("RVB23 Profile Release")
-  Rake::Task["#{$root}/gen/profile_doc/pdf/RVB23.pdf"].invoke
+  Rake::Task["#{$root}/gen/profile/pdf/RVB23.pdf"].invoke
 end
 
 def portfolio_start_msg(name)
@@ -391,9 +391,9 @@ task "MC200-32": "#{$root}/gen/crd/pdf/MC200-32.pdf"
 task "MC200-64": "#{$root}/gen/crd/pdf/MC200-64.pdf"
 task "MC300-32": "#{$root}/gen/crd/pdf/MC300-32.pdf"
 task "MC300-64": "#{$root}/gen/crd/pdf/MC300-64.pdf"
-task "MockProfileRelease": "#{$root}/gen/profile_doc/pdf/MockProfileRelease.pdf"
-task "RVI20": "#{$root}/gen/profile_doc/pdf/RVI20.pdf"
-task "RVA20": "#{$root}/gen/profile_doc/pdf/RVA20.pdf"
-task "RVA22": "#{$root}/gen/profile_doc/pdf/RVA22.pdf"
-task "RVA23": "#{$root}/gen/profile_doc/pdf/RVA23.pdf"
-task "RVB23": "#{$root}/gen/profile_doc/pdf/RVB23.pdf"
+task "MockProfileRelease": "#{$root}/gen/profile/pdf/MockProfileRelease.pdf"
+task "RVI20": "#{$root}/gen/profile/pdf/RVI20.pdf"
+task "RVA20": "#{$root}/gen/profile/pdf/RVA20.pdf"
+task "RVA22": "#{$root}/gen/profile/pdf/RVA22.pdf"
+task "RVA23": "#{$root}/gen/profile/pdf/RVA23.pdf"
+task "RVB23": "#{$root}/gen/profile/pdf/RVB23.pdf"

backends/common_templates/adoc/README.adoc

@@ -29,23 +29,21 @@ Dir.glob("#{$root}/arch/proc_cert_model/*.yaml") do |f|
     # None of these objects are provided with a Design object when created.
     puts "UPDATE: Creating ProcCertModel for #{model_name}"
     proc_cert_model = arch.proc_cert_model(model_name)
+    proc_cert_class = proc_cert_model.proc_cert_class
 
     # Create the one PortfolioDesign object required for the ERB evaluation.
     puts "UPDATE: Creating PortfolioDesign using processor certificate model #{model_name}"
-    portfolio_design = PortfolioDesign.new(model_name, arch, [proc_cert_model])
+    portfolio_design = PortfolioDesign.new(model_name, arch, [proc_cert_model], proc_cert_class)
 
     # Create empty binding and then specify explicitly which variables the ERB template can access.
     # Seems to use this method name in stack backtraces (hence its name).
     def evaluate_erb
       binding
     end
     erb_binding = evaluate_erb
-    erb_binding.local_variable_set(:arch, arch)
-    erb_binding.local_variable_set(:design, portfolio_design)
-    erb_binding.local_variable_set(:proc_cert_class, proc_cert_model.proc_cert_class)
-    erb_binding.local_variable_set(:portfolio_class, proc_cert_model.proc_cert_class)
+    portfolio_design.init_erb_binding(erb_binding)
     erb_binding.local_variable_set(:proc_cert_model, proc_cert_model)
-    erb_binding.local_variable_set(:portfolio, proc_cert_model)
+    erb_binding.local_variable_set(:proc_cert_class, proc_cert_class)
 
     pf_create_adoc("#{CERT_DOC_DIR}/templates/crd.adoc.erb", erb_binding, t.name, portfolio_design)
   end

backends/crd/tasks.rake

@@ -287,7 +287,7 @@ The following <%= ext.csrs.size %> are added by this extension.
 <%- ext.csrs.each do |csr| -%>
 <<<
 :leveloffset: +2
-<%= partial "adoc/csr.adoc.erb", { csr: csr, design: design } %>
+<%= partial("templates/csr.adoc.erb", { csr: csr, design: design }) %>
 :leveloffset: -2
 <%- end -%>
 
@@ -300,7 +300,7 @@ The following <%= ext.csrs.size %> are added by this extension.
 
 <%- ext.instructions.each do |i| -%>
 :leveloffset: +2
-<%= partial "adoc/inst.adoc.erb", { inst: i, design: design } %>
+<%= partial("templates/inst.adoc.erb", { inst: i, design: design }) %>
 :leveloffset: -2
 
 <<<

backends/ext_pdf_doc/templates/ext_pdf.adoc.erb

@@ -0,0 +1,2 @@
+This portfolio backend isn't a real backend.
+Instead, it contains common Rake code and ERB templates shared by multiple portfolio-based backends.

backends/portfolio/README.adoc

@@ -0,0 +1 @@
+This directory contains partial ERB templates shared by multiple portfolio-based backend.