From b18f67c56652c8f60904eec76471b7e0ece60b67 Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:03:23 -0500 Subject: [PATCH 1/6] clean up precommit --- .vscode/settings.json | 1 + Makefile | 2 +- src/architecture_review.adoc | 4 ++-- src/chairs_best_practices.adoc | 3 +-- src/dev_partner.adoc | 2 +- src/fast_track_extension.adoc | 2 +- src/groups_chairs.adoc | 2 +- src/nonisa_definition_of_done.adoc | 9 ++++----- src/profiles.adoc | 2 +- src/question_response.adoc | 6 +++--- 10 files changed, 16 insertions(+), 17 deletions(-) create mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..9e26dfe --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1 @@ +{} \ No newline at end of file diff --git a/Makefile b/Makefile index 5b085cc..b7a0c43 100644 --- a/Makefile +++ b/Makefile @@ -55,7 +55,7 @@ OPTIONS := --trace \ $(XTRA_ADOC_OPTS) \ -D build \ --failure-level=ERROR -REQUIRES := --require=asciidoctor-bibtex +REQUIRES := --require=asciidoctor-bibtex .PHONY: all build clean build-container build-no-container build-docs diff --git a/src/architecture_review.adoc b/src/architecture_review.adoc index 47a1f7a..23002f4 100644 --- a/src/architecture_review.adoc +++ b/src/architecture_review.adoc @@ -21,7 +21,7 @@ === Rationale -We need to produce robust extensions that are consistent with the ratified RISC-V specifications and RISC-V overall strategy. +We need to produce robust extensions that are consistent with the ratified RISC-V specifications and RISC-V overall strategy. We also need to coordinate assignments of opcode encodings, mnemonics, CSRs, etc so we have a consistent set of conventions across extensions, @@ -95,7 +95,7 @@ choices and suggestions for improvement. However, the Architecture Review conduc during the Freeze stage is particularly important and mandatory, as it determines whether the specification is genuinely prepared to advance or if modifications and enhancements are needed. Lastly, AR is required during the Ratification-Ready -phase if the specification text has undergone any significant changes (i.e. past +phase if the specification text has undergone any significant changes (i.e. past simple typo corrections, formatting corrections, and very simple clarifications). === Exception handling diff --git a/src/chairs_best_practices.adoc b/src/chairs_best_practices.adoc index b403821..2bca84d 100644 --- a/src/chairs_best_practices.adoc +++ b/src/chairs_best_practices.adoc @@ -17,8 +17,7 @@ |1.3 |2022-02-18 |Reference Encumbered information policy for new Chairs |Jeff Scheel -|1.2 |2021-09-24 |Added information for new Chairs. Simplified handling -of inappropriate behavior. |Jeff Scheel +|1.2 |2021-09-24 |Added information for new Chairs. Simplified handling of inappropriate behavior. |Jeff Scheel |=== diff --git a/src/dev_partner.adoc b/src/dev_partner.adoc index 92e807b..814af9d 100644 --- a/src/dev_partner.adoc +++ b/src/dev_partner.adoc @@ -13,7 +13,7 @@ public review and ratification + |=== |Ver |Date |Details |Name(s) -|1.1 |2021-02-02 +|1.1 |2021-02-02 a| Updates: diff --git a/src/fast_track_extension.adoc b/src/fast_track_extension.adoc index 6cd49e3..bc0f9f0 100644 --- a/src/fast_track_extension.adoc +++ b/src/fast_track_extension.adoc @@ -162,7 +162,7 @@ https://drive.google.com/drive/folders/1hzoPukaf5I-r12kdjpMY5KetoYfvHeCb?usp=sha * This spreadsheet and any associated waivers must be submitted to Tech Chairs and approved. + . Public review + -* The proposer, the two chairs of the relevant Horizontal or ISA +* The proposer, the two chairs of the relevant Horizontal or ISA Committee, and two others outside the proposer’s organization must agree to push for public review and then present such a motion to the `tech' email list - with a two-week period for objections to be raised. + diff --git a/src/groups_chairs.adoc b/src/groups_chairs.adoc index 4fe4253..54570a6 100644 --- a/src/groups_chairs.adoc +++ b/src/groups_chairs.adoc @@ -117,7 +117,7 @@ Interest Groups, and Task Groups. The Technical Steering Committee requires notification of some decisions that these groups are making in order to provide appropriate oversight. The TSC reserves the right to review and adjust decisions made by any of the working groups or committees. Each policy will call out, at the top of the document, if the TSC requires notification of any process detailed in a RISC-V policy document. See the TSC Required Notification Statement below for the full text. [IMPORTANT] -*TSC Required Notification Statement:* +*TSC Required Notification Statement:* This document contains delegated tasks from the Technical Steering Committee (TSC). The TSC requires notification of these delegated tasks (highlighted in red) and reserves the right to review and adjust at any diff --git a/src/nonisa_definition_of_done.adoc b/src/nonisa_definition_of_done.adoc index e68b040..fa7a6b6 100644 --- a/src/nonisa_definition_of_done.adoc +++ b/src/nonisa_definition_of_done.adoc @@ -11,9 +11,9 @@ |=== |Ver |Date |Details |Name(s) -|1.2 |2021-10-05 |elaborate on custom plans | -|1.1 |2021-09-28 |require sign off for non isa specs | -|1.0 |2021-08-16 |who approves customized portions of Non-ISA DoD | +|1.2 |2021-10-05 |elaborate on custom plans | +|1.1 |2021-09-28 |require sign off for non isa specs | +|1.0 |2021-08-16 |who approves customized portions of Non-ISA DoD | |0.1 |2021-03-22 |Original draft |Gajinder Panesar, Arun Thomas and Greg Favor + |=== @@ -115,5 +115,4 @@ Freeze milestone. === Exception handling -Any Task Group wanting an exception from any part of this policy must get written approval from the Chairs. The exception should list the explicit rows that need to be waived, the cause for needing the waiver, and when they will get done. To set expectations: it is likely Chairs will only grant waivers for items in the earlier part of the DoD and unlikely that Chairs will grant permanent waivers at all. - +Any Task Group wanting an exception from any part of this policy must get written approval from the Chairs. The exception should list the explicit rows that need to be waived, the cause for needing the waiver, and when they will get done. To set expectations: it is likely Chairs will only grant waivers for items in the earlier part of the DoD and unlikely that Chairs will grant permanent waivers at all. diff --git a/src/profiles.adoc b/src/profiles.adoc index c554713..61a08a2 100644 --- a/src/profiles.adoc +++ b/src/profiles.adoc @@ -129,7 +129,7 @@ don’t conflict in any way with required or optional standard extensions. === Transition to start using policy -This will be the acting policy until approved (possibly with modifications before approval). +This will be the acting policy until approved (possibly with modifications before approval). Upon approval of this policy, implementations must adhere to the policy. Existing branding must transition within 12 months unless an exception diff --git a/src/question_response.adoc b/src/question_response.adoc index 0c36d97..8eb0f46 100644 --- a/src/question_response.adoc +++ b/src/question_response.adoc @@ -1,5 +1,5 @@ [[question_response]] -== Question Response +== Question Response *Version:* 1.1 + *One line description:* Answer member questions reliably within a SLA and @@ -45,12 +45,12 @@ github in the README. The chairs of those groups should at least respond to emails within 24-48 hours M-F except on holidays (i.e. business days). -Responses can be one of three things: +Responses can be one of three things: . answer and resolve the question, + . notify the requester that the question belongs to another group and CC that group who in turn should respond in accordance with -this policy or +this policy or . acknowledge receipt of the question and tell the responder when they should expect an answer by the chair or someone else (it may take time to get someone to answer because they don’t have the From 1da1d17c46e854f7f792743a216ed5a86bc41f27 Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:10:17 -0500 Subject: [PATCH 2/6] missed stuff --- src/architecture_review.adoc | 13 +++++++------ src/fast_track_extension.adoc | 4 ++-- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/src/architecture_review.adoc b/src/architecture_review.adoc index 23002f4..931394c 100644 --- a/src/architecture_review.adoc +++ b/src/architecture_review.adoc @@ -91,12 +91,13 @@ stages: Planning, Development, Freeze, and Ratification-Ready. During the Planning and Development phases, AR functions primarily as a consultative activity, offering requested guidance on possible architectural -choices and suggestions for improvement. However, the Architecture Review conducted -during the Freeze stage is particularly important and mandatory, as it determines -whether the specification is genuinely prepared to advance or if modifications -and enhancements are needed. Lastly, AR is required during the Ratification-Ready -phase if the specification text has undergone any significant changes (i.e. past -simple typo corrections, formatting corrections, and very simple clarifications). +choices and suggestions for improvement. However, the Architecture Review +conducted during the Freeze stage is particularly important and mandatory, as +it determines whether the specification is genuinely prepared to advance or if +modifications and enhancements are needed. Lastly, AR is required during the +Ratification-Ready phase if the specification text has undergone any significant +changes (i.e. past simple typo corrections, formatting corrections, and very +simple clarifications). === Exception handling diff --git a/src/fast_track_extension.adoc b/src/fast_track_extension.adoc index bc0f9f0..8a6e284 100644 --- a/src/fast_track_extension.adoc +++ b/src/fast_track_extension.adoc @@ -162,7 +162,7 @@ https://drive.google.com/drive/folders/1hzoPukaf5I-r12kdjpMY5KetoYfvHeCb?usp=sha * This spreadsheet and any associated waivers must be submitted to Tech Chairs and approved. + . Public review + -* The proposer, the two chairs of the relevant Horizontal or ISA +* The proposer, the two chairs of the relevant Horizontal or ISA Committee, and two others outside the proposer’s organization must agree to push for public review and then present such a motion to the `tech' email list - with a two-week period for objections to be raised. + @@ -171,7 +171,7 @@ enters the standard 30-day public review process. This is announced via email to `isa-dev' and to the `tech' email list. + . Approval by TSC + * All comments from the public review must be addressed. + -* The proposer, the two chairs of the relevant Horizontal or ISA +* The proposer, the two chairs of the relevant Horizontal or ISA Committee, and two others outside the proposer’s organization must agree to push for approval and then present such a motion to the `tech-announce' email list (tech-announce@lists.riscv.org) - with a From 64fa44d1f6a5745d73c806b26721e2ee8adfbcc2 Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:16:51 -0500 Subject: [PATCH 3/6] last one --- src/architecture_review.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/architecture_review.adoc b/src/architecture_review.adoc index 931394c..26da7fa 100644 --- a/src/architecture_review.adoc +++ b/src/architecture_review.adoc @@ -89,14 +89,14 @@ In the process of developing the RISC-V Specification, Architecture Review (AR) serves a pivotal function. This review can occur at various stages: Planning, Development, Freeze, and Ratification-Ready. -During the Planning and Development phases, AR functions primarily as a -consultative activity, offering requested guidance on possible architectural -choices and suggestions for improvement. However, the Architecture Review -conducted during the Freeze stage is particularly important and mandatory, as -it determines whether the specification is genuinely prepared to advance or if -modifications and enhancements are needed. Lastly, AR is required during the -Ratification-Ready phase if the specification text has undergone any significant -changes (i.e. past simple typo corrections, formatting corrections, and very +During the Planning and Development phases, AR functions primarily as a +consultative activity, offering requested guidance on possible architectural +choices and suggestions for improvement. However, the Architecture Review +conducted during the Freeze stage is particularly important and mandatory, as +it determines whether the specification is genuinely prepared to advance or if +modifications and enhancements are needed. Lastly, AR is required during the +Ratification-Ready phase if the specification text has undergone any significant +changes (i.e. past simple typo corrections, formatting corrections, and very simple clarifications). === Exception handling From e19498401d0a370e51e4c954e0d802a1a603ccab Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:23:34 -0500 Subject: [PATCH 4/6] sigh forgot the end of file spaces --- src/act.adoc | 1 - src/ccm_guest_policy.adoc | 1 - src/chairs_best_practices.adoc | 1 - src/dev_partner.adoc | 1 - src/ecosystem_labs.adoc | 1 - src/encumbered_info.adoc | 1 - src/github_administration.adoc | 1 - src/gnu_toolchain_signoff_criteria.adoc | 1 - src/groups_chairs.adoc | 1 - src/intro.adoc | 1 - src/isa_nonisa.adoc | 1 - src/joint_working_groups.adoc | 1 - src/llvm_toolchain_signoff.adoc | 1 - src/os_hypervisor_requirements.adoc | 1 - src/platforms.adoc | 1 - src/policy.adoc | 1 - src/profiles.adoc | 1 - src/ratification.adoc | 1 - src/rationale.adoc | 1 - src/technical_voting.adoc | 1 - src/universes.adoc | 1 - 21 files changed, 21 deletions(-) diff --git a/src/act.adoc b/src/act.adoc index 5045666..495de82 100644 --- a/src/act.adoc +++ b/src/act.adoc @@ -331,4 +331,3 @@ be only supported through vendor efforts and not through RISC-V. Any escalation should occur to the CTO who may choose to resolve the issue, or escalate to the TSC or the CEO or the BOD. - diff --git a/src/ccm_guest_policy.adoc b/src/ccm_guest_policy.adoc index b45b54b..0991041 100644 --- a/src/ccm_guest_policy.adoc +++ b/src/ccm_guest_policy.adoc @@ -73,4 +73,3 @@ conversation. Guests may not request this. === Transition to start using policy Immediate - diff --git a/src/chairs_best_practices.adoc b/src/chairs_best_practices.adoc index 2bca84d..b8630a9 100644 --- a/src/chairs_best_practices.adoc +++ b/src/chairs_best_practices.adoc @@ -229,4 +229,3 @@ Active as of now as it is only advice === Exceptions Not applicable - diff --git a/src/dev_partner.adoc b/src/dev_partner.adoc index 814af9d..fff5f5c 100644 --- a/src/dev_partner.adoc +++ b/src/dev_partner.adoc @@ -127,4 +127,3 @@ Not applicable === Transition to start using policy Immediately - diff --git a/src/ecosystem_labs.adoc b/src/ecosystem_labs.adoc index 292b632..a338c64 100644 --- a/src/ecosystem_labs.adoc +++ b/src/ecosystem_labs.adoc @@ -139,4 +139,3 @@ email to help@riscv.org. === Transition to start using policy + Immediately upon approval - diff --git a/src/encumbered_info.adoc b/src/encumbered_info.adoc index faefd1f..e164992 100644 --- a/src/encumbered_info.adoc +++ b/src/encumbered_info.adoc @@ -77,4 +77,3 @@ modifications before approval). === Exceptions + None allowed. - diff --git a/src/github_administration.adoc b/src/github_administration.adoc index 3221830..379685c 100644 --- a/src/github_administration.adoc +++ b/src/github_administration.adoc @@ -187,4 +187,3 @@ changes. === Exception Handling The CTO is the escalation path for all policy issues, with the authority to resolve them or, if necessary, escalate further to the TSC or the BOD. - diff --git a/src/gnu_toolchain_signoff_criteria.adoc b/src/gnu_toolchain_signoff_criteria.adoc index 1a7570c..c9de0ed 100644 --- a/src/gnu_toolchain_signoff_criteria.adoc +++ b/src/gnu_toolchain_signoff_criteria.adoc @@ -64,4 +64,3 @@ 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 index 54570a6..ed11f67 100644 --- a/src/groups_chairs.adoc +++ b/src/groups_chairs.adoc @@ -521,4 +521,3 @@ the CTO. the CTO may further escalate to TSC or the BOD. Members who feel their escalation is not being addressed appropriately should send email to help@riscv.org. Members should try to work through their HC or IC first, if possible, before sending email. - diff --git a/src/intro.adoc b/src/intro.adoc index ffb0475..5e9086b 100644 --- a/src/intro.adoc +++ b/src/intro.adoc @@ -49,4 +49,3 @@ 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 + - diff --git a/src/isa_nonisa.adoc b/src/isa_nonisa.adoc index 0e07e53..42d200c 100644 --- a/src/isa_nonisa.adoc +++ b/src/isa_nonisa.adoc @@ -118,4 +118,3 @@ 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 index 3659645..9773585 100644 --- a/src/joint_working_groups.adoc +++ b/src/joint_working_groups.adoc @@ -95,4 +95,3 @@ Escalations get sent to the executives to resolve. === Transition to start using policy Effective immediately - diff --git a/src/llvm_toolchain_signoff.adoc b/src/llvm_toolchain_signoff.adoc index bf76369..44953b2 100644 --- a/src/llvm_toolchain_signoff.adoc +++ b/src/llvm_toolchain_signoff.adoc @@ -120,4 +120,3 @@ 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/os_hypervisor_requirements.adoc b/src/os_hypervisor_requirements.adoc index e3056c1..cf9e3a5 100644 --- a/src/os_hypervisor_requirements.adoc +++ b/src/os_hypervisor_requirements.adoc @@ -118,4 +118,3 @@ consequently, been addressed) === Transition to start using policy + Immediate - diff --git a/src/platforms.adoc b/src/platforms.adoc index faebd8b..4e053a1 100644 --- a/src/platforms.adoc +++ b/src/platforms.adoc @@ -388,4 +388,3 @@ 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 index b62f9d0..4c110a0 100644 --- a/src/policy.adoc +++ b/src/policy.adoc @@ -49,4 +49,3 @@ its exception handling. === Transition to start using policy + Immediate - diff --git a/src/profiles.adoc b/src/profiles.adoc index 61a08a2..6b7fb53 100644 --- a/src/profiles.adoc +++ b/src/profiles.adoc @@ -141,4 +141,3 @@ described in this policy immediately. === Exceptions Profile naming and versioning exceptions must be approved by the TSC. - diff --git a/src/ratification.adoc b/src/ratification.adoc index 42e3bda..d0c0508 100644 --- a/src/ratification.adoc +++ b/src/ratification.adoc @@ -286,4 +286,3 @@ ratified specification. Any exceptions get escalated to the CTO who may choose to resolve the issue, or escalate to the TSC or the CEO or the BOD. - diff --git a/src/rationale.adoc b/src/rationale.adoc index 52b6538..90bd1a7 100644 --- a/src/rationale.adoc +++ b/src/rationale.adoc @@ -103,4 +103,3 @@ hardship along with a recommendation on how, if, and when to answer them. Alternatively they can escalate to TSC and should include some idea about what the TG thinks might have been useful had they had this policy in a more convenient time period. - diff --git a/src/technical_voting.adoc b/src/technical_voting.adoc index 7321e9a..8067363 100644 --- a/src/technical_voting.adoc +++ b/src/technical_voting.adoc @@ -84,4 +84,3 @@ RISC-V CTO directly. === Transition to start using policy Immediate - diff --git a/src/universes.adoc b/src/universes.adoc index 69f0eaa..ec9a310 100644 --- a/src/universes.adoc +++ b/src/universes.adoc @@ -98,4 +98,3 @@ email to help@riscv.org. Cheri will be the test universe and we will not create any others until we agree that the Cheri universe is successful and the universe paradigm is appropriate. - From 8f8a4fc18ffa0524b12906291727ae08253421f3 Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:29:30 -0500 Subject: [PATCH 5/6] Delete .vscode/settings.json Signed-off-by: Kersten Richter --- .vscode/settings.json | 1 - 1 file changed, 1 deletion(-) delete mode 100644 .vscode/settings.json diff --git a/.vscode/settings.json b/.vscode/settings.json deleted file mode 100644 index 9e26dfe..0000000 --- a/.vscode/settings.json +++ /dev/null @@ -1 +0,0 @@ -{} \ No newline at end of file From fdb39ad7a00a8f039244b2096823c99cabf5b9c2 Mon Sep 17 00:00:00 2001 From: Kersten Richter Date: Mon, 30 Sep 2024 14:44:25 -0500 Subject: [PATCH 6/6] maybe? --- src/act.adoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/src/act.adoc b/src/act.adoc index 495de82..e4bc704 100644 --- a/src/act.adoc +++ b/src/act.adoc @@ -117,12 +117,10 @@ implemented, * Any optional feature and configuration parameters allowed by the architecture that are used, defined by listing a YAML formatted file -using the schema defined by the riscv-config format (see -https://riscv-config.readthedocs.io/en/latest/overview.html), +using the schema defined by the riscv-config format (see https://riscv-config.readthedocs.io/en/latest/overview.html), * The vendor and implementation IDs that the DUT will report in those -respective CSRs (should be in the YAML feature/config file), - +respective CSRs (should be in the YAML feature/config file),+ NOTE: these may be zero if unimplemented * Name, commit hash, and either version tags or git commit date (in ISO