chore: renamed profile class to profile family (#811)

james-ball-qualcomm · web-flow · commit 21f2fddf2d8f · 2025-06-03T20:50:02.000Z
Fixes #778
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -111,10 +111,10 @@
     },
     {
       "type": "rdbg",
-      "name": "RVA20",
+      "name": "RVI20",
       "request": "launch",
       "command": "bundle exec rake",
-      "script": "gen:profile_release_pdf[RVA20]",
+      "script": "gen:profile_release_pdf[RVI20]",
       "args": [],
       "askParameters": false
     },
diff --git a/arch/profile_family/Mock.yaml b/arch/profile_family/Mock.yaml
@@ -1,15 +1,15 @@
-$schema: profile_class_schema.json#
-kind: profile class
+$schema: profile_family_schema.json#
+kind: profile family
 processor_kind: Microcontroller
 name: Mock
-long_name: Mock Profile Class
-marketing_name: Mock Profile Class
-introduction: Here's the Mock Profile Class introduction.
+long_name: Mock Profile Family
+marketing_name: Mock Profile Family
+introduction: Here's the Mock Profile Family introduction.
 description: |
-  This is the Mock Profile Class description.
+  This is the Mock Profile Family description.
   It can be longer than the introduction since it gets its own sub-heading.
 naming_scheme: |
-  Here's the Mock Profile Class naming scheme.
+  Here's the Mock Profile Family naming scheme.
 company:
   name: RISC-V International
   url: https://riscv.org
diff --git a/arch/profile_family/RVA.yaml b/arch/profile_family/RVA.yaml
@@ -1,13 +1,13 @@
-# yaml-language-server: $schema=../../schemas/profile_class_schema.json
+# yaml-language-server: $schema=../../schemas/profile_family_schema.json
 
-$schema: profile_class_schema.json#
-kind: profile class
+$schema: profile_family_schema.json#
+kind: profile family
 processor_kind: Apps Processor
 name: RVA
-long_name: Apps Processor profile class for Rich Operating Systems requiring binary-compatibility
+long_name: Apps Processor profile family for Rich Operating Systems requiring binary-compatibility
 marketing_name: RVA
 introduction: |
-  The RVA profile class targets application processors for markets
+  The RVA profile family targets application processors for markets
   requiring a high-degree of binary compatibility between compliant implementations.
 description: |
   RISC-V was designed to provide a highly modular and extensible
@@ -131,7 +131,7 @@ description: |
   worth implementing and worth discovering, by designating only a few
   important features as profile options and limiting their granularity.
 naming_scheme: |
-  The profile class name is RVA (RISC-V Apps processor).
+  The profile family name is RVA (RISC-V Apps processor).
   A profile release name is an integer (currently 2 digits, could grow in the future).
   A full profile name is comprised of, in order:
 
diff --git a/arch/profile_family/RVB.yaml b/arch/profile_family/RVB.yaml
@@ -1,17 +1,17 @@
-$schema: profile_class_schema.json#
-kind: profile class
+$schema: profile_family_schema.json#
+kind: profile family
 processor_kind: Apps Processor
 name: RVB
-long_name: Apps Processor profile class for Bespoke Rich Operating System
+long_name: Apps Processor profile family for Bespoke Rich Operating System
 marketing_name: RVB
 introduction: |
-  The RVB profile class targets application processors for markets
+  The RVB profile family targets application processors for markets
   running Bespoke (AKA custom, AKA Yocto) Linux Operating Systems
   in embedded applications.
 description: |
-  The RVB profile class is intended to be used for 64-bit application
+  The RVB profile family is intended to be used for 64-bit application
   processors running rich OS stacks.  Only user-mode and
-  supervisor-mode profiles are specified in this class.
+  supervisor-mode profiles are specified in this family.
 
   NOTE: There is no machine-mode profile currently defined for RVB.
   A machine-mode profile for application processors would only be used in specifying platforms for
@@ -25,7 +25,7 @@ description: |
   defined.  It would be possible to also define very similar XLEN=32
   variants.
 naming_scheme: |
-  The profile class name is RVB (RISC-V Bespoke processor).
+  The profile family name is RVB (RISC-V Bespoke processor).
   A profile release name is a integer (currently 2 digits, could grow in the future).
   A full profile name is comprised of, in order:
 
diff --git a/arch/profile_family/RVI.yaml b/arch/profile_family/RVI.yaml
@@ -1,20 +1,20 @@
-$schema: profile_class_schema.json#
-kind: profile class
+$schema: profile_family_schema.json#
+kind: profile family
 processor_kind: Generic Unprivileged
 name: RVI
 long_name: Unprivileged nstructions
 marketing_name: RVI
-introduction: The RVI profile class documents the initial set of unprivileged instructions.
+introduction: The RVI profile family documents the initial set of unprivileged instructions.
 description: |
-  The RVI profile class provides a generic target for software toolchains
+  The RVI profile family provides a generic target for software toolchains
   and represent the minimum level of compatibility with RISC-V ratified standards.
 
-  NOTE: Profiles in this class are designated as _unprivileged_ profiles as opposed to
-  _user_-_mode_ profiles.  Code using this profile class can run in any
+  NOTE: Profiles in this family are designated as _unprivileged_ profiles as opposed to
+  _user_-_mode_ profiles.  Code using this profile family can run in any
   privilege mode, and so requested and fatal traps may be horizontal
   traps into an execution environment running in the same privilege mode.
 naming_scheme: |
-  The profile class name is RVI (RISC-V base Integer instructions).
+  The profile family name is RVI (RISC-V base Integer instructions).
   A profile release name is an integer (currently 2 digits, could grow in the future).
   A full profile name is comprised of, in order:
 
diff --git a/arch/profile_release/Mock.yaml b/arch/profile_release/Mock.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: Mock
 long_name: Mock
 marketing_name: Mock Profile Release Marketing Name
-class:
-  $ref: profile_class/Mock.yaml#
+family:
+  $ref: profile_family/Mock.yaml#
 release: 20
 state: ratified # current status ["ratified", "development"]
 versions:
diff --git a/arch/profile_release/RVA20.yaml b/arch/profile_release/RVA20.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: RVA20
 long_name: RVA20
 marketing_name: RVA20
-class:
-  $ref: profile_class/RVA.yaml#
+family:
+  $ref: profile_family/RVA.yaml#
 release: 20
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
diff --git a/arch/profile_release/RVA22.yaml b/arch/profile_release/RVA22.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: RVA22
 long_name: RVA22
 marketing_name: RVA22
-class:
-  $ref: profile_class/RVA.yaml#
+family:
+  $ref: profile_family/RVA.yaml#
 release: 22
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
diff --git a/arch/profile_release/RVA23.yaml b/arch/profile_release/RVA23.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: RVA23
 long_name: RVA23
 marketing_name: RVA23
-class:
-  $ref: profile_class/RVA.yaml#
+family:
+  $ref: profile_family/RVA.yaml#
 release: 23
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
diff --git a/arch/profile_release/RVB23.yaml b/arch/profile_release/RVB23.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: RVB23
 long_name: RVB23
 marketing_name: RVB23
-class:
-  $ref: profile_class/RVB.yaml#
+family:
+  $ref: profile_family/RVB.yaml#
 release: 23
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
diff --git a/arch/profile_release/RVI20.yaml b/arch/profile_release/RVI20.yaml
@@ -3,8 +3,8 @@ kind: profile release
 name: RVI20
 long_name: RVI20
 marketing_name: RVI20
-class:
-  $ref: profile_class/RVI.yaml#
+family:
+  $ref: profile_family/RVI.yaml#
 base: null
 state: ratified # current status ["ratified", "development"]
 ratification_date: "2023-04-03"
diff --git a/backends/profile/tasks.rake b/backends/profile/tasks.rake
@@ -12,9 +12,9 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
   release_obj = YAML.load_file(f, permitted_classes: [Date])
   raise "Can't parse #{f}" if release_obj.nil?
 
-  raise "Ill-formed profile release file #{f}: missing 'class' field" if release_obj['class'].nil?
-  class_name = File.basename(release_obj['class']['$ref'].split("#")[0], ".yaml")
-  raise "Ill-formed profile release file #{f}: can't parse class name" if class_name.nil?
+  raise "Ill-formed profile release file #{f}: missing 'family' field" if release_obj['family'].nil?
+  family_name = File.basename(release_obj['family']['$ref'].split("#")[0], ".yaml")
+  raise "Ill-formed profile release file #{f}: can't parse family name" if family_name.nil?
 
   raise "Ill-formed profile release file #{f}: missing 'profiles' field" if release_obj['profiles'].nil?
   profile_names = release_obj['profiles'].map {|p| File.basename(p['$ref'].split("#")[0], ".yaml") }
@@ -24,7 +24,7 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
 
   file "#{PROFILE_GEN_DIR}/adoc/#{release_name}ProfileRelease.adoc" => [
     __FILE__,
-    "#{$root}/arch/profile_class/#{class_name}.yaml",
+    "#{$root}/arch/profile_family/#{family_name}.yaml",
     "#{$root}/arch/profile_release/#{release_name}.yaml",
     "#{$root}/lib/arch_obj_models/profile.rb",
     "#{$root}/lib/arch_obj_models/portfolio.rb",
@@ -41,7 +41,7 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
     arch = pf_create_arch
 
     # Create ProfileRelease for specific profile release as specified in its arch YAML file.
-    # The Architecture object also creates all other portfolio-related class instances from their arch YAML files.
+    # The Architecture object also creates all other portfolio-related object instances from their arch YAML files.
     # None of these objects are provided with a AbstractConfig or Design object when created.
     $logger.info "Creating ProfileRelease with only an Architecture object for #{release_name}"
     profile_release_with_arch = arch.profile_release(release_name)
@@ -51,7 +51,6 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
 
     $logger.info "Creating ProfileRelease with a ConfiguredArchitecture object for #{release_name}"
     profile_release_with_cfg_arch = cfg_arch.profile_release(release_name)
-    profile_class_with_cfg_arch = profile_release_with_cfg_arch.profile_class
 
     # Create the one PortfolioDesign object required for the ERB evaluation.
     # Provide it with all the profiles in this ProfileRelease.
@@ -61,7 +60,7 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
       cfg_arch,
       PortfolioDesign.profile_release_type,
       profile_release_with_cfg_arch.profiles,
-      profile_release_with_cfg_arch.profile_class
+      profile_release_with_cfg_arch.profile_family
     )
 
     # Create empty binding and then specify explicitly which variables the ERB template can access.
@@ -72,7 +71,7 @@ Dir.glob("#{$root}/arch/profile_release/*.yaml") do |f|
     erb_binding = evaluate_erb
     portfolio_design.init_erb_binding(erb_binding)
     erb_binding.local_variable_set(:profile_release, profile_release_with_cfg_arch)
-    erb_binding.local_variable_set(:profile_class, profile_release_with_cfg_arch.profile_class)
+    erb_binding.local_variable_set(:profile_family, profile_release_with_cfg_arch.profile_family)
 
     pf_create_adoc("#{PROFILE_DOC_DIR}/templates/profile.adoc.erb", erb_binding, t.name, portfolio_design)
   end
diff --git a/backends/profile/templates/profile.adoc.erb b/backends/profile/templates/profile.adoc.erb
@@ -15,18 +15,18 @@
 [preface]
 == Copyright and license information
 This document is released under the
-<% if profile_class.doc_license.url.nil? -%>
-<%= profile_class.doc_license.name %>.
+<% if profile_family.doc_license.url.nil? -%>
+<%= profile_family.doc_license.name %>.
 <% else -%>
-<%= profile_class.doc_license.url %>[<%= profile_class.doc_license.name %>].
+<%= profile_family.doc_license.url %>[<%= profile_family.doc_license.name %>].
 <% end -%>
 
 <% if profile_release.ratification_date.nil? -%>
 Copyright <%= Date.today.year %>
 <% else -%>
 Copyright <%= profile_release.ratification_date.year %>
 <% end -%>
-by <%= profile_class.company.name %>.
+by <%= profile_family.company.name %>.
 
 <% unless profile_release.contributors.nil? -%>
 [preface]
@@ -263,28 +263,28 @@ are by definition non-profile extensions.  For example, mandatory or
 optional profile extensions for a new profile might be prototyped as
 non-profile extensions on an earlier profile.
 
-== <%= profile_class.name %> Profile Class
+== <%= profile_family.name %> Profile Family
 
-<%= profile_class.introduction %>
+<%= profile_family.introduction %>
 
-=== <%= profile_class.name %> Description
+=== <%= profile_family.name %> Description
 
-<%= profile_class.description %>
+<%= profile_family.description %>
 
-=== <%= profile_class.name %> Naming Scheme
+=== <%= profile_family.name %> Naming Scheme
 
-<%= profile_class.naming_scheme %>
+<%= profile_family.naming_scheme %>
 
 NOTE: Profile names are embeddable into RISC-V ISA naming strings.
 This implies that there will be no standard ISA extension with a name
 that matches the profile naming convention.  This allows tools that
 process the RISC-V ISA naming string to parse and/or process a combined string.
 
-=== <%= profile_class.name %> Profile Releases
+=== <%= profile_family.name %> Profile Releases
 
-The following profile releases are defined in this profile class:
+The following profile releases are defined in this profile family:
 
-<% profile_class.profile_releases.each do |profile_release| -%>
+<% profile_family.profile_releases.each do |profile_release| -%>
 --
 Name:: <%= profile_release.marketing_name %>
 State:: <%= profile_release.state %>
@@ -350,31 +350,31 @@ associated implementation-defined parameters.
 [appendix]
 == Profile Comparisons
 
-=== <%= profile_class.processor_kind %> Profile Releases
+=== <%= profile_family.processor_kind %> Profile Releases
 
-The <%= profile_class.processor_kind %> processor kind has <%= profile_class.profile_releases_matching_processor_kind.size %> processor
-profile releases that reference a total of <%= profile_class.in_scope_extensions_matching_processor_kind.size %> extensions.
+The <%= profile_family.processor_kind %> processor kind has <%= profile_family.profile_releases_matching_processor_kind.size %> processor
+profile releases that reference a total of <%= profile_family.in_scope_extensions_matching_processor_kind.size %> extensions.
 
 .Extension Presence
 |===
-| Extension | <%= profile_class.profile_releases_matching_processor_kind.map(&:marketing_name).join(" | ") %>
+| Extension | <%= profile_family.profile_releases_matching_processor_kind.map(&:marketing_name).join(" | ") %>
 
-<% profile_class.in_scope_extensions_matching_processor_kind.sort_by(&:name).each do |ext| -%>
-| <%= ext.name %> | <%= profile_class.profile_releases_matching_processor_kind.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
+<% profile_family.in_scope_extensions_matching_processor_kind.sort_by(&:name).each do |ext| -%>
+| <%= ext.name %> | <%= profile_family.profile_releases_matching_processor_kind.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
 <% end -%>
 |===
 
-=== <%= profile_class.marketing_name %> Profile Releases
+=== <%= profile_family.marketing_name %> Profile Releases
 
-The <%= profile_class.marketing_name %> Profile Class has <%= profile_class.profile_releases.size %> releases that
-reference a total of <%= profile_class.in_scope_extensions.size %> extensions.
+The <%= profile_family.marketing_name %> Profile Family has <%= profile_family.profile_releases.size %> releases that
+reference a total of <%= profile_family.in_scope_extensions.size %> extensions.
 
 .Extension Presence
 |===
-| Extension | <%= profile_class.profile_releases.map(&:marketing_name).join(" | ") %>
+| Extension | <%= profile_family.profile_releases.map(&:marketing_name).join(" | ") %>
 
-<% profile_class.in_scope_extensions.each do |ext| -%>
-| <%= ext.name %> | <%= profile_class.profile_releases.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
+<% profile_family.in_scope_extensions.each do |ext| -%>
+| <%= ext.name %> | <%= profile_family.profile_releases.map { |profile_release| profile_release.extension_presence(ext.name) }.join(" | ") %>
 <% end -%>
 |===
 
diff --git a/lib/arch_obj_models/database_obj.rb b/lib/arch_obj_models/database_obj.rb
@@ -22,7 +22,7 @@ class Kind < T::Enum
       ProcessorCertificateClass = new("processor certificate class")
       ProcessorCertificateModel = new("processor certificate model")
       Profile = new("profile")
-      ProflieClass = new("profile class")
+      ProfileFamily = new("profile family")
       ProfileRelease = new("profile release")
     end
   end
diff --git a/lib/arch_obj_models/portfolio.rb b/lib/arch_obj_models/portfolio.rb
@@ -21,7 +21,7 @@
 # PortfolioClass #
 ##################
 
-# Holds information from Portfolio class YAML file (processor certificate class or profile class).
+# Holds information from Portfolio class YAML file (processor certificate class or profile family).
 # The inherited "data" member is the database of extensions, instructions, CSRs, etc.
 class PortfolioClass < TopLevelDatabaseObject
   # @return [String] What kind of processor portfolio is this?
diff --git a/lib/arch_obj_models/profile.rb b/lib/arch_obj_models/profile.rb
diff --git a/lib/architecture.rb b/lib/architecture.rb
diff --git a/schemas/profile_family_schema.json b/schemas/profile_family_schema.json
