links and descriptions

riscv-admin · Oct 2, 2024 · c1622b3 · c1622b3
1 parent 7081dfa
commit c1622b3
Show file tree

Hide file tree

Showing 33 changed files with 110 additions and 84 deletions.
diff --git a/src/acceptance_criteria.adoc b/src/acceptance_criteria.adoc
@@ -1,8 +1,9 @@
 [[acceptance_criteria]]
 == Acceptance Criteria
 
+Describes what must be complete before TSC can approve a specification for ratification.
+
 *Version:* 1.2 +
-*One line description:* What must be complete before TSC can approve a specification for ratification +
 *Author(s)*: Mark I Himelstein, Stephano Cetola +
 *Status:* Approved +
 

diff --git a/src/act.adoc b/src/act.adoc
@@ -1,10 +1,11 @@
 [[act]]
 == Architectural Compatibility Test
 
-*Version:* 1.2 +
-*One line description:* These are the rules that explain the rationale
+These are the rules that explain the rationale
 for, and the requirements for running and reporting results of RISC-V
-architectural tests, and conditions for waiving failures. +
+architectural tests, and conditions for waiving failures.
+
+*Version:* 1.2 +
 *Author(s):* Allen Baum, Ken Dockser +
 *Status:* Approved +
 

diff --git a/src/act_priv_spec_1_11.adoc b/src/act_priv_spec_1_11.adoc
@@ -1,11 +1,12 @@
 [[act_priv_spec_1_11]]
 == ACT Requirements for Privileged 1.11 Specification
 
-*Version:* 0.2 +
-*One line description:* This policy describes simplified Architectural
+This policy describes simplified Architectural
 Compatibility Test (ACT) requirements for the privileged specification.
 This policy is temporary and will be replaced by a standard ACT suite in
-the future. +
+the future.
+
+*Version:* 0.2 +
 *Author(s):* Greg Favor, Arun Thomas +
 *Status:* Archived +
 

diff --git a/src/architecture_review.adoc b/src/architecture_review.adoc
@@ -1,8 +1,9 @@
 [[architecture_review]]
 == Architecture Review
 
+This policy covers the opcode encoding, mnemonics, and CSR.
+
 *Version:* 1.2 +
-*One line description:* This policy cover the opcode encoding, mnemonics, and CSR +
 *Author(s):* Greg Favor, Krste Asanović +
 *Status:* Approved +
 

diff --git a/src/ccm_guest_policy.adoc b/src/ccm_guest_policy.adoc
@@ -1,8 +1,9 @@
 [[ccm_guest_policy]]
 == Committee Chair Meeting (CCM) Guests
 
+Describes the circumstances for allowing or asking guests to join CCM.
+
 *Version:* 1.1 +
-*One line description:* Under what circumstances do we allow/ask guests to join CCM +
 *Author(s):* Mark Himelstein, Stephano Cetola +
 *Status:* Approved +
 

diff --git a/src/chairs_best_practices.adoc b/src/chairs_best_practices.adoc
@@ -1,8 +1,9 @@
 [[chairs_best_practices]]
 == Chairs Best Practices
 
+Guidance on practices for chairs and vice-chairs.
+
 *Version:* 1.5 +
-*One line description:* Guidance on practices if you are a chair or vice-chair +
 *Author(s):* Charlie Su, Mark Himelstein, Jeff Scheel +
 *Status:* Approved +
 

diff --git a/src/contributors.adoc b/src/contributors.adoc
@@ -1,6 +1,6 @@
 == Contributors
 
-This RISC-V specification has been contributed to directly or indirectly by:
+This RISC-V specification has been contributed to directly or indirectly by the following people:
 
 [%hardbreaks]
 * Allen Baum <allen[email protected]>

diff --git a/src/dev_partner.adoc b/src/dev_partner.adoc
@@ -1,10 +1,11 @@
 [[dev_partner]]
 == Development Partner Model
 
-*Version:* 1.1 +
-*One line description:* Process and policies regarding being a development
+Describes the process and policies regarding being a development
 partner and doing projects to help Task Groups complete DoD tasks for
-public review and ratification +
+public review and ratification
+
+*Version:* 1.1 +
 *Author(s):* Mark Himelstein +
 *Status:* Approved +
 

diff --git a/src/ecosystem_labs.adoc b/src/ecosystem_labs.adoc
@@ -1,8 +1,9 @@
 [[ecosystem_labs]]
 == Ecosystem Labs
 
+Provides the processes and policies for RISC-V Ecosystem Labs.
+
 *Version:* 1.2 +
-*One line description:* processes and policies regarding being a RISC-V Ecosystem Lab +
 *Author(s):* Mark Himelstein, Jeff Scheel +
 *Status:* Approved +
 

diff --git a/src/encumbered_info.adoc b/src/encumbered_info.adoc
@@ -1,9 +1,9 @@
 [[encumbered_info]]
 == Encumbered Information
 
+Describes when and why you can or cannot discuss or reference encumbered information.
+
 *Version:* 1.3 +
-*One line description:* When and why you can or cannot discuss or
-reference encumbered information +
 *Author(s):* Mark I Himelstein +
 *Status:* Approved +
 

diff --git a/src/fast_track_extension.adoc b/src/fast_track_extension.adoc
@@ -1,8 +1,9 @@
 [[fast_track_extension]]
 == Fast Track Architecture Extension
 
-*One line description:* ast track process for developing "small"
-architecture extensions +
+Provides the fast-track process for developing "small" architecture extensions.
+
+*Version:* 1.7
 *Author(s):* Greg Favor +
 *Status:* Approved +
 

diff --git a/src/friendly_terminology.adoc b/src/friendly_terminology.adoc
@@ -1,9 +1,9 @@
 [[friendly_terminology]]
 == Friendly Terminology
 
+Defines the modern word choices for terminology that is friendly for everyone.
+
 *Version:* 1.2 +
-*One line description:* Modern word choice for terminology that is
-friendly for everyone +
 *Author(s):* Mark Himelstein +
 *Status:* Approved +
 

diff --git a/src/github_administration.adoc b/src/github_administration.adoc
@@ -1,9 +1,9 @@
 [[github_administration]]
 == GitHub Repo Structure & Administration
 
+This policy governs use of RISC-V’s GitHub organization.
+
 *Version:* 1.2 +
-*One line description:* This policy governs use of RISC-V’s GitHub
-organization. +
 *Author(s):* Stephano Cetola, Arun Thomas +
 *Status:* Approved +
 

diff --git a/src/gnu_toolchain_signoff_criteria.adoc b/src/gnu_toolchain_signoff_criteria.adoc
@@ -1,8 +1,9 @@
 [[gnu_toolchain_signoff_criteria]]
 == GNU Tool Chain Sign-Off Criteria
 
+Defines the criteria for acceptance of GNU tool chain modifications.
+
 *Version:*  1.1 +
-*One line description:*  Criteria for acceptance of GNU tool chain modifications +
 *Author(s):*  Tariq Kurd, Huawei; Jeremy Bennett, Embecosm +
 *Status:*  Approved by Toolchain & Runtimes SSC on 28 Jan 2021 +
 
@@ -64,3 +65,4 @@ Immediate on approval
 . Identify at least two specific people from TSC to review the policy before it is approved. +
 . Have the TSC chair and CTO review the proposal. +
 . If approved, communicate to all task/sig groups commissioning GNU tool chain work. +
+
diff --git a/src/groups_chairs.adoc b/src/groups_chairs.adoc
@@ -1,9 +1,9 @@
 [[groups_chairs]]
 == Group Chair and Vice-Chair Approvals
 
+Defines RISC-V technical working groups and selection process.
+
 *Version:* 1.15 +
-*One line description:* Defines RISC-V technical working groups and
-selection process. +
 *Author(s):* Mark Himelstein, Stephano Cetola +
 *Status:* Approved +
 

diff --git a/src/intro.adoc b/src/intro.adoc
@@ -9,43 +9,43 @@ The project to build the document is maintained in GitHub at https://github.com/
 
 The following policies are in the Approved state and are in use:
 
-* Acceptance Criteria +
-* Architectural Compatibility Test +
-* Architecture Review +
-* Committee Chair Meeting (CCM) Guests +
-* Chairs Best Practices +
-* Contributor +
-* Development Partner Model +
-* Ecosystem Labs +
-* Encumbered Information +
-* Fast Track Architecture Extension +
-* Friendly Terminology +
-* GitHub Repo Structure & Administration +
-* GNU Tool Chain Sign-Off Criteria +
-* Group Chair and Vice-Chair Approvals +
-* ISA & Non-ISA Specifications +
-* Joint Working Groups with External Organizations +
-* Platforms +
-* Policy +
-* Profiles +
-* Questions Response +
-* Ratification +
-* Rationale +
-* Technical Voting +
+* <<acceptance_criteria>> +
+* <<act>> +
+* <<architecture_review>> +
+* <<ccm_guest_policy>> +
+* <<chairs_best_practices>> +
+* <<riscv_contributor>> +
+* <<dev_partner>> +
+* <<ecosystem_labs>> +
+* <<encumbered_info>> +
+* <<fast_track_extension>> +
+* <<friendly_terminology>> +
+* <<github_administration>> +
+* <<gnu_toolchain_signoff_criteria>> +
+* <<groups_chairs>> +
+* <<isa_nonisa>> +
+* <<joint_working_groups>> +
+* <<platforms>> +
+* <<policy>> +
+* <<profiles>> +
+* <<question_response>> +
+* <<ratification>> +
+* <<rationale>> +
+* <<technical_voting>> +
 
 === Draft policy list
 
 Policies in this section have been been drafted but not yet approved:
 
-* LLVM Tool Chain Sign-Off Criteria +
-* OS & Hypervisor Requirements for Specification Ratification +
-* Universes +
-* Versioning +
+* <<llvm_toochain_singoff>> +
+* <<os_hypervisor_requirements>> +
+* <<universes>> +
+* <<versioning>> +
 
 === Archived policy list
 
 Policies in this section are no longer in use by RISC-V:
 
-* ACT Requirements for Privileged 1.11 Specification +
-* Non-ISA Definition of Done +
-* SAIL Requirements for Privileged 1.11 Extensions +
+* <<act_priv_spec_1_11>> +
+* <<nonisa_definition_of_done>> +
+* <<sail_priv_spec_1_11>> +
diff --git a/src/isa_nonisa.adoc b/src/isa_nonisa.adoc
@@ -1,9 +1,9 @@
 [[isa_nonisa]]
 == ISA & Non-ISA Specifications
 
+Differentiate governance and branding for Non-ISA specifications and artifacts.
+
 *Version:* 1.1 +
-*One line description:* Differentiate governance and branding for Non-ISA
-specifications and artifacts +
 *Author(s):* Mark Himelstein +
 *Status:* Approved +
 
@@ -118,3 +118,4 @@ adhere to this policy. +
 by 2021-07-01. +
 . Any non-ISA items that were already ratified will be considered
 approved.
+
diff --git a/src/joint_working_groups.adoc b/src/joint_working_groups.adoc
@@ -1,9 +1,9 @@
 [[joint_working_groups]]
 == Joint Working Groups with External Organizations
 
+Defines the policy and process to set up a joint working group with other organizations.
+
 *Version:* 1.0 +
-*One line description:* policy and process to set up a joint working group
-with other organizations +
 *Author(s):* Mark Himelstein +
 *Status:* Approved +
 
@@ -94,4 +94,5 @@ Escalations get sent to the executives to resolve.
 
 === Transition to start using policy
 
-Effective immediately
+Effective immediately +
+
diff --git a/src/llvm_toolchain_signoff.adoc b/src/llvm_toolchain_signoff.adoc
@@ -1,8 +1,9 @@
 [[llvm_toochain_singoff]]
 == LLVM Tool Chain Sign-Off Criteria
 
+Specifies the criteria for acceptance of LLVM tool chain.
+
 *Version:* 0.1 +
-*One line description:* Criteria for acceptance of LLVM tool chain +
 *Author(s):* Nidal Faour, Jeremy Bennett, Ed Jones +
 *Status:* Draft +
 
@@ -120,3 +121,4 @@ by reviewers by two weeks). +
 . Identify at least two specific people from TSC to review the policy
 before it is approved. +
 . Have the TSC chair and CTO review the proposal.
+
diff --git a/src/nonisa_definition_of_done.adoc b/src/nonisa_definition_of_done.adoc
@@ -1,8 +1,9 @@
 [[nonisa_definition_of_done]]
 == Non-ISA Definition of Done
 
+Describes the tasks that must be completed before TSC can ratify a specification or change to a specification.
+
 *Version:*  1.2 +
-*One line description:* What must be completed before TSC can ratify a specification or change to a specification +
 *Author(s):* Gajinder Panesar, Arun Thomas and Greg Favor +
 *Status:* Archived +
 

diff --git a/src/os_hypervisor_requirements.adoc b/src/os_hypervisor_requirements.adoc
@@ -1,10 +1,10 @@
 [[os_hypervisor_requirements]]
 == OS & Hypervisor Requirements for Specification Ratification
 
+Provide a reference implementation (as a patchset) providing basic 
+enablement for Linux (including KVM) and FreeRTOS/Zephyr.
+
 *Version:* 0.1 +
-*One line description:* Provide a reference implementation (as a patchset)
-providing basic enablement for Linux (including KVM) and
-FreeRTOS/Zephyr. +
 *Author(s):* Philipp Tomsich +
 *Status:* Draft +
 

diff --git a/src/platforms.adoc b/src/platforms.adoc
@@ -1,11 +1,12 @@
 [[platforms]]
 == Platforms
 
+Defines the rules for platforms’ specifications
+
 NOTE: This policy is out-of-date but will not be updated until 2023.
 It is left here for historical reasons.
 
 *Version:* 1.0 +
-*One line description:* Rules for platforms’ specifications +
 *Author(s):* Philipp Tomsich +
 *Status:* Approved +
 
@@ -388,3 +389,4 @@ Compatibility test.* +
 specifications and provide additional functionality, as long as they
 remain compatible* (i.e., they may not implement incompatible features
 unless these are disabled by default).
+
diff --git a/src/policy.adoc b/src/policy.adoc
@@ -1,8 +1,9 @@
 [[policy]]
 == Policy
 
+Outlines how to propose, approve, and adopt policies.
+
 *Version:* 1.2 +
-*One line description:* How to propose, approve, and adopt policies +
 *Author(s):* Mark I Himelstein +
 *Status:* Approved +
 

diff --git a/src/profiles.adoc b/src/profiles.adoc
@@ -1,8 +1,9 @@
 [[profiles]]
 == Profiles
 
+Defines the rules for profiles.
+
 *Version:* 3.3 +
-*One line description:* Rules for profiles +
 *Author(s):* Mark Himelstein +
 *Status:*  +
 
@@ -141,3 +142,4 @@ described in this policy immediately.
 === Exceptions
 
 Profile naming and versioning exceptions must be approved by the TSC.
+
diff --git a/src/question_response.adoc b/src/question_response.adoc
@@ -1,9 +1,10 @@
 [[question_response]]
 == Question Response
 
+Answer member questions reliably within a SLA and
+identify who is responsible for ensuring questions are answered.
+
 *Version:* 1.1 +
-*One line description:* Answer member questions reliably within a SLA and
-identify who is responsible for ensuring questions are answered +
 *Author(s):* Mark I Himelstein +
 *Status:* Approved +