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

Asciidoc Artifact Generation #323

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Asciidoc Artifact Generation #323

wants to merge 2 commits into from

Conversation

IIITM-Jay
Copy link
Member

Description

This PR deals with generating asciidoc based format in the form encoding.adoc on running upon Makefile via make command.

Approach Used

  1. Created an asciidoc_utils.py script to generate the asciidoc related output
  2. The make_asciidoc() function will be called in the main parse.py script
  3. Made necessary and needed changes for Makefile
  4. Taken reference from encoding.out.h and c_utils.py

@IIITM-Jay
Copy link
Member Author

@aswaterman needed your feedback on this PR.

@AFOliveira
Copy link
Contributor

Hello!
I was browsing through the PR's and I think this asciidoc output is something really great! I don't know if you have seen my previous attempts at this; initial approach is here riscv/riscv-isa-manual#1590) and this is where I ended
riscv-encodings.pdf. I think that great future additions to this PR could be the wavedrom and splitting instructions by extensions. If you want to see my approach, most of it is here . If this is well accepted, I'd be more than interested in collaborating and getting this inside this full asciidoc generation inside this repo :)

@rpsene rpsene closed this Nov 20, 2024
@rpsene
Copy link
Contributor

rpsene commented Nov 20, 2024

.adoc is correctly generated, @aswaterman we need your input on whether the date in the .adoc is correct. I'm attaching a pdf created out of the asciidoc file created by executing make.
PS: Edited the below results (the last console for asciidoc related generation can be verified) for better visualization

Running with args : ['./parse.py', '-c', '-go', '-chisel', '-sverilog', '-rust', '-latex', '-spinalhdl', '-asciidoc', 'rv*', 'unratified/rv*']
Extensions selected : ['rv*', 'unratified/rv*']
INFO:: encoding.out.h generated successfully
INFO:: inst.chisel generated successfully
INFO:: inst.spinalhdl generated successfully
INFO:: inst.sverilog generated successfully
INFO:: inst.rs generated successfully
INFO:: inst.go generated successfully
INFO:: instr-table.tex generated successfully
INFO:: priv-instr-table.tex generated successfully
INFO:: encoding.adoc generated successfully

@rpsene rpsene reopened this Nov 20, 2024
@rpsene
Copy link
Contributor

rpsene commented Nov 20, 2024

@IIITM-Jay
Copy link
Member Author

@rpsene I think the link is broken for the pdf that you have attached, @aswaterman and @rpsene here I am attaching the same

encoding.pdf

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