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

riscv-zacas created from docs-spec-template template
https://github.com/riscvarchive/riscv-zacas

Last synced: 11 days ago
JSON representation

riscv-zacas created from docs-spec-template template

• Host: GitHub
• URL: https://github.com/riscvarchive/riscv-zacas
• Owner: riscvarchive
• License: cc-by-4.0
• Archived: true
• Created: 2023-04-11T11:37:11.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-21T12:16:41.000Z (8 months ago)
• Last Synced: 2024-11-01T17:02:33.750Z (19 days ago)
• Language: Makefile
• Homepage: https://jira.riscv.org/browse/RVG-122
• Size: 526 KB
• Stars: 9
• Watchers: 7
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: readme.adoc
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[NOTE]

====

Atomic compare-and-swap (Zacas) has been merged into the Unprivileged Specification.  Please log any issues against the link:https://github.com/riscv/riscv-isa-manual[RISC-V ISA Manual] repository.

====

= RISC-V Atomic compare-and-swap (CAS) instructions

The Zacas extension adds support for `amocas.w`, `amocas.d`, and `amocas.q`

instructions to perform atomic Compare-and-Swap (CAS) operations.

= License

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

See the link:LICENSE[LICENSE] file for details.

= Contributors

Contributors to this specification are contained in the link:contributors.adoc[contributors] file.

For instructions on how to contribute please see the link:CONTRIBUTING.md[CONTRIBUTING] file.

= Dependencies

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 and Building the Document

This project uses submodules to include the RISC-V documentation toolchain. 

```

  git clone --recurse-submodule https://github.com/riscv/riscv-zacas.git

  cd ./riscv-zacas.git

  make VERSION=v1.0.0 REVMARK=Draft

```

`VERSION`: Represents the version of the specification being built. By default, this is set to 'v0.0.0'. You can change this to a different value, like 'v1.0.0', 'v1.1.0', etc., based on the current version of your specification.

`REVMARK`: This represents a revision marker for the project. Its default value is 'Draft'. You may want to change this to something like 'Release', 'Stable' or 'Ratified'.