Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Sail asciidoc documentation target to Makefile #277

Merged
merged 1 commit into from
Jun 27, 2023

Conversation

Alasdair
Copy link
Collaborator

@Alasdair Alasdair commented Jun 25, 2023

We have an Asciidoctor plugin that allows incorporating Sail code into ISA manuals written using asciidoc. See https://github.com/Alasdair/asciidoctor-sail. This requires generating a json file using Sail that indexes the source code in the repository. This commit simply adds a target for creating that to the Makefile.

Currently requires the development version of Sail, but I am working on making a new opam release of Sail for the documentation support, and there should be no harm in getting the Makefile target here set up in advance, or for those who are already using a development build.

@github-actions
Copy link

github-actions bot commented Jun 25, 2023

Unit Test Results

712 tests  ±0   712 ✔️ ±0   0s ⏱️ ±0s
    6 suites ±0       0 💤 ±0 
    1 files   ±0       0 ±0 

Results for commit 1d274b7. ± Comparison against base commit 787ccfb.

♻️ This comment has been updated with latest results.

@jrtc27
Copy link
Collaborator

jrtc27 commented Jun 25, 2023

Should this not be per-ARCH? Which files are included varies between RV32 and RV64. Even if technically the set of instruction sources is the same.

@Alasdair
Copy link
Collaborator Author

Updated to be per-arch. Possibly not that useful because the code is mostly the same, other than the virtual memory code. I think that code could probably be merged so it's parametric and therefore not per-arch, but not sure when I'd have the time to do that.

@jrtc27
Copy link
Collaborator

jrtc27 commented Jun 26, 2023

Agreed, and you’d need that anyway for mutable S-mode XLEN

Copy link
Collaborator

@billmcspadden-riscv billmcspadden-riscv left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@billmcspadden-riscv billmcspadden-riscv added the tgmm-agenda Tagged for the next Golden Model meeting agenda. label Jun 27, 2023
@billmcspadden-riscv billmcspadden-riscv merged commit 5c12d94 into riscv:master Jun 27, 2023
@billmcspadden-riscv
Copy link
Collaborator

Merge approved at the tech-golden-model meeting on 2023-06-27

@billmcspadden-riscv billmcspadden-riscv removed the tgmm-agenda Tagged for the next Golden Model meeting agenda. label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants