From 9cbc67a02e93b302784934891626776d6f9fd7c1 Mon Sep 17 00:00:00 2001 From: Kevin Broch Date: Wed, 22 May 2024 11:33:12 -0700 Subject: [PATCH] Update spec to use latest doc workflow from docs-spec-template relates to #167 Signed-off-by: Kevin Broch --- .github/workflows/build.yml | 94 +-- .github/workflows/pre-commit.yml | 15 + .gitignore | 4 +- .pre-commit-config.yaml | 25 + CONTRIBUTING.md | 59 ++ LICENSE | 713 ++++++++++-------- MAINTAINERS.md | 5 + Makefile | 80 +- README.adoc | 107 +++ dependencies/README.md | 3 - docs-resources | 2 +- images/riscv-images | 1 - .../RVA-profile-overview.adoc | 0 src/contributors.adoc | 7 + .../old-m-profiles.adoc | 2 +- profiles.adoc => src/profiles.adoc | 27 +- .../rva-profile-overview-body.adoc | 0 rva23-profile.adoc => src/rva23-profile.adoc | 3 +- rvb23-profile.adoc => src/rvb23-profile.adoc | 3 +- rvm23-profile.adoc => src/rvm23-profile.adoc | 3 +- 20 files changed, 710 insertions(+), 443 deletions(-) create mode 100644 .github/workflows/pre-commit.yml create mode 100644 .pre-commit-config.yaml create mode 100644 CONTRIBUTING.md create mode 100644 MAINTAINERS.md create mode 100644 README.adoc delete mode 100644 dependencies/README.md delete mode 120000 images/riscv-images rename RVA-profile-overview.adoc => src/RVA-profile-overview.adoc (100%) create mode 100644 src/contributors.adoc rename old-m-profiles.adoc => src/old-m-profiles.adoc (99%) rename profiles.adoc => src/profiles.adoc (99%) rename rva-profile-overview-body.adoc => src/rva-profile-overview-body.adoc (100%) rename rva23-profile.adoc => src/rva23-profile.adoc (99%) rename rvb23-profile.adoc => src/rvb23-profile.adoc (99%) rename rvm23-profile.adoc => src/rvm23-profile.adoc (99%) diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1689a67..ec254c7 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -5,21 +5,21 @@ on: workflow_dispatch: inputs: version: - description: 'Release version, e.g. X.Y.Z:' + description: "Release version, e.g. X.Y.Z:" required: true type: string - revision_mark: - description: 'Set revision mark as Draft, Release or Stable:' - required: true - type: string - default: 'Draft' + revision_mark: + description: "Set revision mark as Draft, Release or Stable:" + required: true + type: string + default: "Draft" prerelease: - description: 'Tag as a pre-release?' + description: "Tag as a pre-release?" required: false type: boolean default: true draft: - description: 'Create release as a draft?' + description: "Create release as a draft?" required: false type: boolean default: false @@ -33,45 +33,45 @@ jobs: runs-on: ubuntu-latest steps: - # Step 1: Checkout the repository - - name: Checkout repository - uses: actions/checkout@v3 - with: - submodules: 'recursive' + # Step 1: Checkout the repository + - name: Checkout repository + uses: actions/checkout@v4 + with: + submodules: "recursive" + + # Step 2: Pull the latest RISC-V Docs container image + - name: Pull Container + run: docker pull riscvintl/riscv-docs-base-container-image:latest - # Step 2: Pull the latest RISC-V Docs container image - - name: Pull Container - run: docker pull riscvintl/riscv-docs-base-container-image:latest + # Step 3: Build Files + - name: Build Files + run: make + env: + VERSION: v${{ github.event.inputs.version }} + REVMARK: ${{ github.event.inputs.revision_mark }} - # Step 3: Build Files - - name: Build Files - run: make - env: - VERSION: v${{ github.event.inputs.version }} - REVMARK: ${{ github.event.inputs.revision_mark }} + # Step 4: Upload the built PDF files as a single artifact + - name: Upload Build Artifacts + uses: actions/upload-artifact@v4 + with: + name: Build Artifacts + path: | + ${{ github.workspace }}/build/*.pdf + ${{ github.workspace }}/build/*.html + retention-days: 30 - # Step 4: Upload the built PDF files as a single artifact - - name: Upload Build Artifacts - uses: actions/upload-artifact@v3 - with: - name: Build Artifacts - path: | - ${{ github.workspace }}/*.pdf - ${{ github.workspace }}/*.html - retention-days: 30 - - # Create Release - - name: Create Release - uses: softprops/action-gh-release@v1 - with: - files: | - ${{ github.workspace }}/*.pdf - ${{ github.workspace }}/*.html - tag_name: v${{ github.event.inputs.version }} - name: Release ${{ github.event.inputs.version }} - draft: ${{ github.event.inputs.draft }} - prerelease: ${{ github.event.inputs.prerelease }} - env: - GITHUB_TOKEN: ${{ secrets.GHTOKEN }} - if: github.event_name == 'workflow_dispatch' - # This condition ensures this step only runs for workflow_dispatch events. + # Create Release + - name: Create Release + uses: softprops/action-gh-release@v1 + with: + files: | + ${{ github.workspace }}/build/*.pdf + ${{ github.workspace }}/build/*.html + tag_name: v${{ github.event.inputs.version }} + name: Release ${{ github.event.inputs.version }} + draft: ${{ github.event.inputs.draft }} + prerelease: ${{ github.event.inputs.prerelease }} + env: + GITHUB_TOKEN: ${{ secrets.GHTOKEN }} + if: github.event_name == 'workflow_dispatch' + # This condition ensures this step only runs for workflow_dispatch events. diff --git a/.github/workflows/pre-commit.yml b/.github/workflows/pre-commit.yml new file mode 100644 index 0000000..74b9ec3 --- /dev/null +++ b/.github/workflows/pre-commit.yml @@ -0,0 +1,15 @@ +--- +name: pre-commit + +on: + pull_request: + push: + branches: [main] + +jobs: + pre-commit: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + - uses: actions/setup-python@v5 + - uses: pre-commit/action@v3.0.0 diff --git a/.gitignore b/.gitignore index 3f6b211..04814f4 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ .DS_Store .*.swp -*.pdf -*.html +/build/* +/images/* diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..15d0620 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,25 @@ +--- +repos: + - repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.6.0 + hooks: + - id: check-json + - id: check-symlinks + - id: check-yaml + - id: end-of-file-fixer + - id: trailing-whitespace + args: [--markdown-linebreak-ext=md] + + - repo: local + hooks: + - id: forbidden-file-extensions + name: forbidden-file-extensions + entry: disallow these file extensions + language: fail + # Disallow other asciidoc extensions except .adoc + files: .*\.(asciidoc|asc)$ + + - repo: https://github.com/rbubley/mirrors-prettier + rev: v3.2.5 + hooks: + - id: prettier diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..16c8645 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,59 @@ +# Contribution Guidelines + +As an open-source project, we appreciate and encourage community members to submit patches directly to the project. To maintain a well-organized development environment, we have established standards and methods for submitting changes. This document outlines the process for submitting patches to the project, ensuring that your contribution is swiftly incorporated into the codebase. + +# Licensing + +Licensing is crucial for open-source projects, as it guarantees that the software remains available under the conditions specified by the author. + +This project employs the Creative Commons Attribution 4.0 International license, which can be found in the LICENSE file within the project's repository. + +Licensing defines the rights granted to you as an author by the copyright holder. It is essential for contributors to fully understand and accept these licensing rights. In some cases, the copyright holder may not be the contributor, such as when the contributor is working on behalf of a company. + +# Developer Certificate of Origin (DCO) + +To uphold licensing criteria and demonstrate good faith, this project mandates adherence to the Developer Certificate of Origin (DCO) process. + +The DCO is an attestation appended to every contribution from each author. In the commit message of the contribution (explained in greater detail later in this document), the author adds a Signed-off-by statement, thereby accepting the DCO. + +When an author submits a patch, they affirm that they possess the right to submit the patch under the designated license. The DCO agreement is displayed below and at https://developercertificate.org. + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I +have the right to submit it under the open source license +indicated in the file; or + +(b) The contribution is based upon previous work that, to the best +of my knowledge, is covered under an appropriate open source +license and I have the right under that license to submit that +work with modifications, whether created in whole or in part +by me, under the same open source license (unless I am +permitted to submit under a different license), as indicated +in the file; or + +(c) The contribution was provided directly to me by some other +person who certified (a), (b), or (c), and I have not modified +it. + +(d) I understand and agree that this project and the contribution +are public and that a record of the contribution (including all +personal information I submit with it, including my sign-off) is +maintained indefinitely and may be redistributed consistent with +this project or the open source license(s) involved. + +# DCO Sign-Off Methods + +The DCO necessitates the inclusion of a sign-off message in the following format for each commit within the pull request: + +Signed-off-by: Stephano Cetola + +Please use your real name in the sign-off message. + +You can manually add the DCO text to your commit body or include either -s or --signoff in your standard Git commit commands. If you forget to incorporate the sign-off, you can also amend a previous commit with the sign-off by executing git commit --amend -s. If you have already pushed your changes to GitHub, you will need to force push your branch afterward using git push -f. + +Note: + +Ensure that the name and email address associated with your GitHub account match the name and email address in the Signed-off-by line of your commit message. diff --git a/LICENSE b/LICENSE index 27e8c60..2f244ac 100644 --- a/LICENSE +++ b/LICENSE @@ -1,350 +1,395 @@ -reative Commons Attribution 4.0 International Public License ("CC BY 4.0") +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. -https://creativecommons.org/licenses/by/4.0/ +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More_considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= +Creative Commons Attribution 4.0 International Public License +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. -Creative Commons Corporation (“Creative Commons”) is not a law firm and does not -provide legal services or legal advice. Distribution of Creative Commons public -licenses does not create a lawyer-client or other relationship. Creative Commons -makes its licenses and related information available on an “as-is” basis. -Creative Commons gives no warranties regarding its licenses, any material -licensed under their terms and conditions, or any related information. Creative -Commons disclaims all liability for damages resulting from their use to the -fullest extent possible. + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). -USING CREATIVE COMMONS PUBLIC LICENSES + b. Other rights. -Creative Commons public licenses provide a standard set of terms and conditions -that creators and other rights holders may use to share original works of -authorship and other material subject to copyright and certain other rights -specified in the public license below. The following considerations are for -informational purposes only, are not exhaustive, and do not form part of our -licenses. + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. -Considerations for licensors: + 2. Patent and trademark rights are not licensed under this + Public License. -Our public licenses are intended for use by those authorized to give the public -permission to use material in ways otherwise restricted by copyright and certain -other rights. Our licenses are irrevocable. Licensors should read and understand -the terms and conditions of the license they choose before applying it. -Licensors should also secure all rights necessary before applying our licenses -so that the public can reuse the material as expected. Licensors should clearly -mark any material not subject to the license. This includes other CC-licensed -material, or material used under an exception or limitation to copyright. + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. -Considerations for the public: +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. -By using one of our public licenses, a licensor grants the public permission to -use the licensed material under specified terms and conditions. If the -licensor’s permission is not necessary for any reason–for example, because of -any applicable exception or limitation to copyright–then that use is not -regulated by the license. Our licenses grant only permissions under copyright -and certain other rights that a licensor has authority to grant. Use of the -licensed material may still be restricted for other reasons, including because -others have copyright or other rights in the material. A licensor may make -special requests, such as asking that all changes be marked or described. -Although not required by our licenses, you are encouraged to respect those -requests where reasonable. + a. Attribution. + 1. If You Share the Licensed Material (including in modified + form), You must: + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. -Creative Commons Attribution 4.0 International Public License -By exercising the Licensed Rights (defined below), You accept and agree to be -bound by the terms and conditions of this Creative Commons Attribution 4.0 -International Public License ("Public License"). To the extent this Public -License may be interpreted as a contract, You are granted the Licensed Rights in -consideration of Your acceptance of these terms and conditions, and the Licensor -grants You such rights in consideration of benefits the Licensor receives from -making the Licensed Material available under these terms and conditions. - -Section 1 – Definitions. - - a. Adapted Material means material subject to Copyright and Similar Rights - that is derived from or based upon the Licensed Material and in which the - Licensed Material is translated, altered, arranged, transformed, or - otherwise modified in a manner requiring permission under the Copyright - and Similar Rights held by the Licensor. For purposes of this Public - License, where the Licensed Material is a musical work, performance, or - sound recording, Adapted Material is always produced where the Licensed - Material is synched in timed relation with a moving image. - - b. Adapter's License means the license You apply to Your Copyright and - Similar Rights in Your contributions to Adapted Material in accordance - with the terms and conditions of this Public License. - - c. Copyright and Similar Rights means copyright and/or similar rights closely - related to copyright including, without limitation, performance, - broadcast, sound recording, and Sui Generis Database Rights, without - regard to how the rights are labeled or categorized. For purposes of this - Public License, the rights specified in Section 2(b)(1)-(2) are not - Copyright and Similar Rights. - - d. Effective Technological Measures means those measures that, in the absence - of proper authority, may not be circumvented under laws fulfilling - obligations under Article 11 of the WIPO Copyright Treaty adopted on - December 20, 1996, and/or similar international agreements. - - e. Exceptions and Limitations means fair use, fair dealing, and/or any other - exception or limitation to Copyright and Similar Rights that applies to - Your use of the Licensed Material. - - f. Licensed Material means the artistic or literary work, database, or other - material to which the Licensor applied this Public License. - - g. Licensed Rights means the rights granted to You subject to the terms and - conditions of this Public License, which are limited to all Copyright and - Similar Rights that apply to Your use of the Licensed Material and that - the Licensor has authority to license. - - h. Licensor means the individual(s) or entity(ies) granting rights under this - Public License. - - i. Share means to provide material to the public by any means or process that - requires permission under the Licensed Rights, such as reproduction, - public display, public performance, distribution, dissemination, - communication, or importation, and to make material available to the - public including in ways that members of the public may access the - material from a place and at a time individually chosen by them. - - j. Sui Generis Database Rights means rights other than copyright resulting - from Directive 96/9/EC of the European Parliament and of the Council of 11 - March 1996 on the legal protection of databases, as amended and/or - succeeded, as well as other essentially equivalent rights anywhere in the - world. - - k. You means the individual or entity exercising the Licensed Rights under - this Public License. Your has a corresponding meaning. - -Section 2 – Scope. - - a. License grant - - 1. Subject to the terms and conditions of this Public License, the - Licensor hereby grants You a worldwide, royalty-free, - non-sublicensable, non-exclusive, irrevocable license to exercise the - Licensed Rights in the Licensed Material to: - - A. reproduce and Share the Licensed Material, in whole or in part; and - - B. produce, reproduce, and Share Adapted Material. - - 2. Exceptions and Limitations. For the avoidance of doubt, where - Exceptions and Limitations apply to Your use, this Public License does - not apply, and You do not need to comply with its terms and conditions. - - 3. Term. The term of this Public License is specified in Section 6(a). - - 4. Media and formats; technical modifications allowed. The Licensor - authorizes You to exercise the Licensed Rights in all media and formats - whether now known or hereafter created, and to make technical - modifications necessary to do so. The Licensor waives and/or agrees not - to assert any right or authority to forbid You from making technical - modifications necessary to exercise the Licensed Rights, including - technical modifications necessary to circumvent Effective Technological - Measures. For purposes of this Public License, simply making - modifications authorized by this Section 2(a)(4) never produces Adapted - Material. - - 5. Downstream recipients. - - A. Offer from the Licensor – Licensed Material. Every recipient of the - Licensed Material automatically receives an offer from the Licensor - to exercise the Licensed Rights under the terms and conditions of - this Public License. - - B. No downstream restrictions. You may not offer or impose any - additional or different terms or conditions on, or apply any - Effective Technological Measures to, the Licensed Material if doing - so restricts exercise of the Licensed Rights by any recipient of the - Licensed Material. - - 6. No endorsement. Nothing in this Public License constitutes or may be - construed as permission to assert or imply that You are, or that Your - use of the Licensed Material is, connected with, or sponsored, - endorsed, or granted official status by, the Licensor or others - designated to receive attribution as provided in Section 3(a)(1)(A)(i). - - b. Other rights - - 1. Moral rights, such as the right of integrity, are not licensed under - this Public License, nor are publicity, privacy, and/or other similar - personality rights; however, to the extent possible, the Licensor - waives and/or agrees not to assert any such rights held by the Licensor - to the limited extent necessary to allow You to exercise the Licensed - Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this Public License. - - 3. To the extent possible, the Licensor waives any right to collect - royalties from You for the exercise of the Licensed Rights, whether - directly or through a collecting society under any voluntary or - waivable statutory or compulsory licensing scheme. In all other cases - the Licensor expressly reserves any right to collect such royalties. - -Section 3 – License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the following conditions. - - a. Attribution - - 1. If You Share the Licensed Material (including in modified form), You - must: - - A. retain the following if it is supplied by the Licensor with the - Licensed Material: - - i. identification of the creator(s) of the Licensed Material and any - others designated to receive attribution, in any reasonable - manner requested by the Licensor (including by pseudonym if - designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of warranties; - - v. a URI or hyperlink to the Licensed Material to the extent - reasonably practicable; - - B. indicate if You modified the Licensed Material and retain an - indication of any previous modifications; and - - C. indicate the Licensed Material is licensed under this Public - License, and include the text of, or the URI or hyperlink to, this - Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any reasonable - manner based on the medium, means, and context in which You Share the - Licensed Material. For example, it may be reasonable to satisfy the - conditions by providing a URI or hyperlink to a resource that includes - the required information. - - 3. If requested by the Licensor, You must remove any of the information - required by Section 3(a)(1)(A) to the extent reasonably practicable. - - 4. If You Share Adapted Material You produce, the Adapter's License You - apply must not prevent recipients of the Adapted Material from - complying with this Public License. - -Section 4 – Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that apply to Your -use of the Licensed Material: - - a. for the avoidance of doubt, Section 2(a)(1) grants You the right to - extract, reuse, reproduce, and Share all or a substantial portion of the - contents of the database; - - b. if You include all or a substantial portion of the database contents in a - database in which You have Sui Generis Database Rights, then the database - in which You have Sui Generis Database Rights (but not its individual - contents) is Adapted Material; and - - c. You must comply with the conditions in Section 3(a) if You Share all or a - substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not replace Your -obligations under this Public License where the Licensed Rights include other -Copyright and Similar Rights. - -Section 5 – Disclaimer of Warranties and Limitation of Liability. - - a. Unless otherwise separately undertaken by the Licensor, to the extent - possible, the Licensor offers the Licensed Material as-is and - as-available, and makes no representations or warranties of any kind - concerning the Licensed Material, whether express, implied, statutory, or - other. This includes, without limitation, warranties of title, - merchantability, fitness for a particular purpose, non-infringement, - absence of latent or other defects, accuracy, or the presence or absence - of errors, whether or not known or discoverable. Where disclaimers of - warranties are not allowed in full or in part, this disclaimer may not - apply to You. - - b. To the extent possible, in no event will the Licensor be liable to You on - any legal theory (including, without limitation, negligence) or otherwise - for any direct, special, indirect, incidental, consequential, punitive, - exemplary, or other losses, costs, expenses, or damages arising out of - this Public License or use of the Licensed Material, even if the Licensor - has been advised of the possibility of such losses, costs, expenses, or - damages. Where a limitation of liability is not allowed in full or in - part, this limitation may not apply to You. - - c. The disclaimer of warranties and limitation of liability provided above - shall be interpreted in a manner that, to the extent possible, most - closely approximates an absolute disclaimer and waiver of all liability. - -Section 6 – Term and Termination. - - a. This Public License applies for the term of the Copyright and Similar - Rights licensed here. However, if You fail to comply with this Public - License, then Your rights under this Public License terminate - automatically. - - b. Where Your right to use the Licensed Material has terminated under - Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided it is - cured within 30 days of Your discovery of the violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any right - the Licensor may have to seek remedies for Your violations of this Public - License. - - c. For the avoidance of doubt, the Licensor may also offer the Licensed - Material under separate terms or conditions or stop distributing the - Licensed Material at any time; however, doing so will not terminate this - Public License. - - d. Sections 1, 5, 6, 7, and 8 survive termination of this Public License. - -Section 7 – Other Terms and Conditions. - - a. The Licensor shall not be bound by any additional or different terms or - conditions communicated by You unless expressly agreed. - - b. Any arrangements, understandings, or agreements regarding the Licensed - Material not stated herein are separate from and independent of the terms - and conditions of this Public License. - -Section 8 – Interpretation. - - a. For the avoidance of doubt, this Public License does not, and shall not be - interpreted to, reduce, limit, restrict, or impose conditions on any use - of the Licensed Material that could lawfully be made without permission - under this Public License. - - b. To the extent possible, if any provision of this Public License is deemed - unenforceable, it shall be automatically reformed to the minimum extent - necessary to make it enforceable. If the provision cannot be reformed, it - shall be severed from this Public License without affecting the - enforceability of the remaining terms and conditions. - - c. No term or condition of this Public License will be waived and no failure - to comply consented to unless expressly agreed to by the Licensor. - - d. Nothing in this Public License constitutes or may be interpreted as a - limitation upon, or waiver of, any privileges and immunities that apply to - the Licensor or You, including from the legal processes of any - jurisdiction or authority. - -Creative Commons is not a party to its public licenses. Notwithstanding, -Creative Commons may elect to apply one of its public licenses to material it -publishes and in those instances will be considered the “Licensor.” The text of -the Creative Commons public licenses is dedicated to the public domain under the -CC0 Public Domain Dedication. Except for the limited purpose of indicating that -material is shared under a Creative Commons public license or as otherwise -permitted by the Creative Commons policies published at -creativecommons.org/policies, Creative Commons does not authorize the use of the -trademark “Creative Commons” or any other trademark or logo of Creative Commons -without its prior written consent including, without limitation, in connection -with any unauthorized modifications to any of its public licenses or any other -arrangements, understandings, or agreements concerning use of licensed material. -For the avoidance of doubt, this paragraph does not form part of the public -licenses. +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. Creative Commons may be contacted at creativecommons.org. diff --git a/MAINTAINERS.md b/MAINTAINERS.md new file mode 100644 index 0000000..3fe92ea --- /dev/null +++ b/MAINTAINERS.md @@ -0,0 +1,5 @@ +# Maintainers + +This project is maintained by the following people: + +- FIXME diff --git a/Makefile b/Makefile index 81d39f2..b035219 100644 --- a/Makefile +++ b/Makefile @@ -8,67 +8,87 @@ # SPDX-License-Identifier: CC-BY-SA-4.0 # # Description: -# -# This Makefile is designed to automate the process of building and packaging +# +# This Makefile is designed to automate the process of building and packaging # the Doc Template for RISC-V Extensions. -DOCKER_RUN := docker run --rm -v ${PWD}:/build -w /build \ -riscvintl/riscv-docs-base-container-image:latest +DOCS := \ + profiles.adoc + +DATE ?= $(shell date +%Y-%m-%d) +VERSION ?= 1.1 +REVMARK ?= Ratified +DOCKER_IMG := riscvintl/riscv-docs-base-container-image:latest +ifneq ($(SKIP_DOCKER),true) + DOCKER_CMD := docker run --rm -v ${PWD}:/build -w /build \ + ${DOCKER_IMG} \ + /bin/sh -c + DOCKER_QUOTE := " +endif -HEADER_SOURCE := profiles.adoc -PDF_RESULT := $(HEADER_SOURCE:%.adoc=%.pdf) -HTML_RESULT := $(HEADER_SOURCE:%.adoc=%.html) +SRC_DIR := src +BUILD_DIR := build +DOCS_PDF := $(DOCS:%.adoc=%.pdf) +DOCS_HTML := $(DOCS:%.adoc=%.html) + +XTRA_ADOC_OPTS := ASCIIDOCTOR_PDF := asciidoctor-pdf ASCIIDOCTOR_HTML := asciidoctor - OPTIONS := --trace \ -a compress \ -a mathematical-format=svg \ + -a revnumber=${VERSION} \ + -a revremark=${REVMARK} \ + -a revdate=${DATE} \ -a pdf-fontsdir=docs-resources/fonts \ - -a pdf-style=docs-resources/themes/riscv-pdf.yml \ + -a pdf-theme=docs-resources/themes/riscv-pdf.yml \ + $(XTRA_ADOC_OPTS) \ + -D build \ --failure-level=ERROR - REQUIRES := --require=asciidoctor-diagram \ + --require=asciidoctor-lists \ --require=asciidoctor-mathematical -.PHONY: all build clean build-container-pdf build-no-container-pdf build-container-html build-no-container-html +.PHONY: all build clean build-container build-no-container build-docs all: build -build: +build-docs: $(DOCS_PDF) $(DOCS_HTML) + +vpath %.adoc $(SRC_DIR) + +%.pdf: %.adoc + $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) + +%.html: %.adoc + $(DOCKER_CMD) $(DOCKER_QUOTE) $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) $< $(DOCKER_QUOTE) + +build: @echo "Checking if Docker is available..." @if command -v docker >/dev/null 2>&1 ; then \ echo "Docker is available, building inside Docker container..."; \ - $(MAKE) build-container-pdf; \ - $(MAKE) build-container-html; \ + $(MAKE) build-container; \ else \ echo "Docker is not available, building without Docker..."; \ - $(MAKE) build-no-container-pdf; \ - $(MAKE) build-no-container-html; \ + $(MAKE) build-no-container; \ fi -build-container-pdf: +build-container: @echo "Starting build inside Docker container..." - $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE)" + $(MAKE) build-docs @echo "Build completed successfully inside Docker container." -build-no-container-pdf: +build-no-container: @echo "Starting build..." - $(ASCIIDOCTOR_PDF) $(OPTIONS) $(REQUIRES) --out-file=$(PDF_RESULT) $(HEADER_SOURCE) + $(MAKE) SKIP_DOCKER=true build-docs @echo "Build completed successfully." -build-container-html: - @echo "Starting build inside Docker container..." - $(DOCKER_RUN) /bin/sh -c "$(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE)" - @echo "Build completed successfully inside Docker container." - -build-no-container-html: - @echo "Starting build..." - $(ASCIIDOCTOR_HTML) $(OPTIONS) $(REQUIRES) --out-file=$(HTML_RESULT) $(HEADER_SOURCE) - @echo "Build completed successfully." +# Update docker image to latest +docker-pull-latest: + docker pull ${DOCKER_IMG} clean: @echo "Cleaning up generated files..." - rm -f $(PDF_RESULT) $(HTML_RESULT) + rm -rf $(BUILD_DIR) @echo "Cleanup completed." diff --git a/README.adoc b/README.adoc new file mode 100644 index 0000000..48650c3 --- /dev/null +++ b/README.adoc @@ -0,0 +1,107 @@ += RISC-V Profiles + +== License + +This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). For details, see the link:LICENSE[LICENSE] file. + +== Maintainers + +The list of maintainers of this specification is maintained in the link:MAINTAINERS.md[MAINTAINERS] file. + +== Contributors + +The list of contributors to this specification is maintained in the link:src/contributors.adoc[contributors] file. + +For guidelines on how to contribute, refer to the link:CONTRIBUTING.md[CONTRIBUTING] file. + +== Governance + +The governance for this project is defined in the link:GOVERNANCE.md[GOVERNANCE] file. + +Community information, including meeting (if held) and mailing lists are detailed in this file. + +== Building the Document + +=== Directory Structure + +The following directories are used to organize the contents of this repo: + +* `dependencies/`: software dependencies needed to build the specification +* `docs-resources/`: resources for all specifications sourced from link:.gitmodules[git submodule] +* `src/`: source files for the specification +* `build/`: default directory where the build artifacts are generated + +=== Prerequisites + +To build the document, you'll need the following tools installed on your system: + +* Make +* asciiDoctor-pdf, asciidoctor-bibtex, asciidoctor-diagram, and asciidoctor-mathematical +* Docker + +=== Cloning the Repository + +```shell +git clone --recurse-submodules https://github.com/riscv/riscv-profiles.git +``` + +All in one single line: + +```shell +git clone --recurse-submodules https://github.com/riscv/riscv-profiles.git && cd riscv-profiles && git submodule update --init --recursive + +``` + +=== Building the Documentation + +To start the build process, run: + +```shell +cd ./riscv-profiles && make build +``` + +The link:Makefile[] script will check the availability of Docker on your system: + +* If Docker is available, the documentation will be built inside a Docker container using the image riscvintl/riscv-docs-base-container-image:latest. This ensures a consistent build environment across different systems. +* If Docker is not available, the documentation will be built directly on your system using the installed tools. + +The documentation is generated from the AsciiDoctor source files in your project. The primary source file is specified by the `HEADER_SOURCE` variable in the Makefile. + +The build process utilizes several options, including theming and font settings, and generates a PDF document as output. + +=== Cleaning up + +To clean up the generated files, run: + +```shell +make clean +``` + +== Enabling pre-commit checks locally + +The repository has some basic commit checks set up with https://pre-commit.com/[pre-commit] that will be enforced by the GitHub CI. +To ensure these checks are also run in the local repository while making changes the following can be done: + +.Installing pre-commit tool +[source,shell] +---- +# Do once on your system +pip3 install pre-commit +---- + +.Installing pre-commit git hook in repo +[source,shell] +---- +# Do once in local repo +pre-commit install +---- + +Rather than doing the above `pre-commit install` in every repo that uses it, you can do it https://pre-commit.com/#automatically-enabling-pre-commit-on-repositories[once on your system.] + +When enabling additional checks https://pre-commit.com/#plugins[by editing .pre-commit-config.yaml], it is recommended running the newly added check on all files in the repository. This can be done with the following command: + +.Running all pre-commit hooks on all files +[source,shell] +---- +pre-commit run --all-files +---- diff --git a/dependencies/README.md b/dependencies/README.md deleted file mode 100644 index 0841ce8..0000000 --- a/dependencies/README.md +++ /dev/null @@ -1,3 +0,0 @@ -Dependencies for the build environment for various package managers. Used in -`.github/workflows/`. - diff --git a/docs-resources b/docs-resources index 8df2cea..6a8935c 160000 --- a/docs-resources +++ b/docs-resources @@ -1 +1 @@ -Subproject commit 8df2cea11ac1c806d639b55157efa78bb1530da1 +Subproject commit 6a8935cd20527e1ae9e7b8e35b5295f38296ad7b diff --git a/images/riscv-images b/images/riscv-images deleted file mode 120000 index 0f20f92..0000000 --- a/images/riscv-images +++ /dev/null @@ -1 +0,0 @@ -../docs-resources/images/ \ No newline at end of file diff --git a/RVA-profile-overview.adoc b/src/RVA-profile-overview.adoc similarity index 100% rename from RVA-profile-overview.adoc rename to src/RVA-profile-overview.adoc diff --git a/src/contributors.adoc b/src/contributors.adoc new file mode 100644 index 0000000..42ef68d --- /dev/null +++ b/src/contributors.adoc @@ -0,0 +1,7 @@ +== Contributors + +This RISC-V specification has been contributed to directly or indirectly by: + +[%hardbreaks] +* FIXME: Author1 +* FIXME: Author2 diff --git a/old-m-profiles.adoc b/src/old-m-profiles.adoc similarity index 99% rename from old-m-profiles.adoc rename to src/old-m-profiles.adoc index b96ac5b..84e91e6 100644 --- a/old-m-profiles.adoc +++ b/src/old-m-profiles.adoc @@ -1,7 +1,7 @@ //// This file contains text on M-mode profiles that was deleted from the proposal. -=== RVA20M64 Profile +=== RVA20M64 Profile The RVA20M64 profile is defined to help provide compatibilty for application-processor platforms that specify an M-mode execution diff --git a/profiles.adoc b/src/profiles.adoc similarity index 99% rename from profiles.adoc rename to src/profiles.adoc index eb812ae..e5effbd 100644 --- a/profiles.adoc +++ b/src/profiles.adoc @@ -1,16 +1,16 @@ -[[riscv-doc-template]] += RISC-V Profiles :description: Short, text description of spect… -:company: RISC-V +:company: RISC-V.org :revdate: April 2, 2023 -:revnumber: 1.1-draft +:revnumber: 1.1 :revremark: This document is in Ratified state. :url-riscv: http://riscv.org :doctype: book :preface-title: Preamble :colophon: :appendix-caption: Appendix -:imagesdir: images -:title-logo-image: image:riscv-images/risc-v_logo.png[pdfwidth=3.25in,align=center] +:imagesdir: ../docs-resources/images +:title-logo-image: image:risc-v_logo.png["RISC-V International Logo",pdfwidth=3.25in,align=center] // Settings: :experimental: :reproducible: @@ -33,31 +33,24 @@ endif::[] :footnote: :xrefstyle: short :numbered: -:stem: latexmath :le: ≤ :ge: ≥ :ne: ≠ :approx: ≈ :inf: ∞ -:sectnums!: - -= RISC-V Profiles - -//: This is the Preamble - [WARNING] .This document is in the link:http://riscv.org/spec-state[Ratified state] ==== No changes are allowed. Any desired or needed changes can be the subject of a follow-on new extension. Ratified extensions are never revised ==== -:sectnums!: - +[preface] == Changes made since ratification - Clarified that Zihpm was optional in RVA20U64 and became mandatory in RVA22U64 +[preface] == Changes since Public Review version 0.8 - Clarified that profile name can be used as ISA base string @@ -67,8 +60,6 @@ No changes are allowed. Any desired or needed changes can be the subject of a fo - Added new extension name Sscounterenw - Removed outdated text on Zicntr/Zihpm ratification plan -:sectnums: - == Introduction RISC-V was designed to provide a highly modular and extensible @@ -368,7 +359,7 @@ There are no mandatory extensions for RVI20U32. - *A* Atomic instructions. - *F* Single-precision floating-point instructions. - + - *D* Double-precision floating-point instructions. NOTE: The rationale to not include Q as an optional extension is that @@ -426,7 +417,7 @@ There are no mandatory extensions for RVI20U64. - *A* Atomic instructions. - *F* Single-precision floating-point instructions. - + - *D* Double-precision floating-point instructions. NOTE: The rationale to not include Q as a profile option is that diff --git a/rva-profile-overview-body.adoc b/src/rva-profile-overview-body.adoc similarity index 100% rename from rva-profile-overview-body.adoc rename to src/rva-profile-overview-body.adoc diff --git a/rva23-profile.adoc b/src/rva23-profile.adoc similarity index 99% rename from rva23-profile.adoc rename to src/rva23-profile.adoc index 627f47e..5ee4700 100644 --- a/rva23-profile.adoc +++ b/src/rva23-profile.adoc @@ -171,7 +171,7 @@ will probably not become mandatory. The following are new development options intended to become mandatory in RVA24U64: -- *Zabha* Byte and Halfword Atomic Memory Operations +- *Zabha* Byte and Halfword Atomic Memory Operations - *Zacas* Compare-and-swap - *Ziccamoc* Main memory regions with both the cacheability and coherence PMAs must provide AMOCASQ level PMA support. @@ -473,4 +473,3 @@ Instruction Set Manual; the hyperlinks lead to their separate specifications. - *Shvstvecd*: `vstvec` supports Direct mode - *Shvsatpa*: `vsatp` supports all modes supported by `satp` - *Shgatpa*: SvNNx4 mode supported for all modes supported by `satp`, as well as Bare - diff --git a/rvb23-profile.adoc b/src/rvb23-profile.adoc similarity index 99% rename from rvb23-profile.adoc rename to src/rvb23-profile.adoc index b7ba1c4..6377aae 100644 --- a/rvb23-profile.adoc +++ b/src/rvb23-profile.adoc @@ -168,7 +168,7 @@ support scalar crypto, as the vector extension is optional in RVB23. The following are new development options intended to become mandatory in RVB24U64: -- *Zabha* Byte and Halfword Atomic Memory Operations +- *Zabha* Byte and Halfword Atomic Memory Operations - *Zacas* Compare-and-swap - *Ziccamoc* Main memory regions with both the cacheability and coherence PMAs must provide AMOCASQ level PMA support. @@ -482,4 +482,3 @@ Instruction Set Manual; the hyperlinks lead to their separate specifications. - *Shvstvecd*: `vstvec` supports Direct mode - *Shvsatpa*: `vsatp` supports all modes supported by `satp` - *Shgatpa*: SvNNx4 mode supported for all modes supported by `satp`, as well as Bare - diff --git a/rvm23-profile.adoc b/src/rvm23-profile.adoc similarity index 99% rename from rvm23-profile.adoc rename to src/rvm23-profile.adoc index f1bc3e4..df2b060 100644 --- a/rvm23-profile.adoc +++ b/src/rvm23-profile.adoc @@ -156,7 +156,7 @@ make Zalrsc available as a separate option. NOTE: This profile does not support Zfinx and related options. A similar set of profiles, tenatively named RVN, would define Zfinx systems. - + - *D* Double-precision floating-point instructions. - *V* Vector Extension. @@ -323,4 +323,3 @@ Instruction Set Manual; the hyperlinks lead to their separate specifications. - *Shvstvecd*: `vstvec` supports Direct mode - *Shvsatpa*: `vsatp` supports all modes supported by `satp` - *Shgatpa*: SvNNx4 mode supported for all modes supported by `satp`, as well as Bare -