https://github.com/riscvarchive/riscv-zawrs

The repo will be used to hold the draft Zawrs (fast-track) extension and to make releases for reviews.
https://github.com/riscvarchive/riscv-zawrs

Last synced: 2 months ago
JSON representation

The repo will be used to hold the draft Zawrs (fast-track) extension and to make releases for reviews.

• Host: GitHub
• URL: https://github.com/riscvarchive/riscv-zawrs
• Owner: riscvarchive
• License: cc-by-4.0
• Archived: true
• Created: 2022-04-22T12:58:48.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-15T15:10:28.000Z (over 1 year ago)
• Last Synced: 2024-06-15T19:32:47.712Z (4 months ago)
• Language: Makefile
• Homepage: https://jira.riscv.org/browse/RVG-122
• Size: 252 KB
• Stars: 6
• Watchers: 10
• Forks: 7
• Open Issues: 0
• Metadata Files:
  • Readme: readme.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
= RISC-V Wait-on-Reservation-Set (Zawrs) extension

The Zawrs extension defines a pair of instructions to be used in polling loops that allows a core to enter a low-power state and wait on a store to a memory location. Waiting for a memory location to be updated is a common pattern in many use cases.

= License

This work is licensed under a Creative Commons Attribution 4.0 International License (CC-BY-4.0). 

See the https://github.com/riscv/docs-spec-template/blob/main/LICENSE[LICENSE] file for details.

= Contributors

Contributors to this specification are contained in the 

https://github.com/riscv/docs-spec-template/blob/main/contributors.adoc[contributors.adoc] file.

= Dependencies

This project is built using AsciiDoctor (Ruby). The repository has been setup to build the PDF on

checkin using GitHub actions.  Workflow dependencies are located in the `dependencies` directory.

For more information on AsciiDoctor, specification guidelines, or building locally, see the

https://github.com/riscv/docs-dev-guide[RISC-V Documentation Developer Guide].

= Cloning the project

This project uses https://git-scm.com/book/en/v2/Git-Tools-Submodules[GitHub Submodules]

to include the https://github.com/riscv/docs-resources[RISC-V docs-resources project]

to achieve a common look and feel.

When cloning this repository for the first time, you must either use 

`git clone --recurse-submodules` or execute `git submodule init` and `git submodule update` after the clone to populate the docs-resources directory.  Failure to clone the submodule, will result

in the PDF build fail with an error message like the following:

    $ make

    asciidoctor-pdf \

    -a toc \

    -a compress \

    -a pdf-style=docs-resources/themes/riscv-pdf.yml \

    -a pdf-fontsdir=docs-resources/fonts \

    --failure-level=ERROR \

    -o profiles.pdf profiles.adoc

    asciidoctor: ERROR: could not locate or load the built-in pdf theme `docs-resources/themes/riscv-pdf.yml'; reverting to default theme

    No such file or directory - notoserif-regular-subset.ttf not found in docs-resources/fonts

      Use --trace for backtrace

    make: *** [Makefile:7: profiles.pdf] Error 1 

= Building the document

The final specification form of PDF can be generated using the `make` command.