Reading spec-in-development docs

62 views
Skip to first unread message

L Peter Deutsch

unread,
Dec 6, 2024, 1:54:12 PM12/6/24
to isa...@groups.riscv.org
I've been trying to browse the docs for some specs in development, and I'm finding it frustrating. Before the switch to Jira, the "Specifications under development" page included links to projects on Github, where I could find a PDF or text file that I could just click on and read. Now, the link goes to a Jira page (which doesn't appear to include any viewable content) with a link to the Github project, which now also doesn't appear to have any viewable content. When I click on any of the .adoc files listed in the project, what it brings up is not the .adoc file (which I'd be perfectly happy to read as a text file), but instructions that direct me to download and install a sizable pile of software (including Docker, although the next section of the instructions says this isn't required) and then run 'make'.

I'm feeling that the current situation discourages the kind of casual reading that might lead someone to want to become more involved, but am I missing something obvious?

--

L Peter Deutsch :: Aladdin Enterprises :: Healdsburg, CA & Burnaby, BC

Rafael Sene

unread,
Dec 6, 2024, 2:18:01 PM12/6/24
to RISC-V ISA Dev, L Peter Deutsch
@Peter, 

You can find it all hereActive Specification Status - (ALL Specs in Progress). This ALL Specs in Progress is a 1-click access to GitHub for each specification.

Regarding the PDF, you can download the PDF from the latest release or build it locally, either using a containerized approach to speed up the configuration process OR using make, assuming you have all dependencies installed. 

L Peter Deutsch

unread,
Dec 6, 2024, 2:33:46 PM12/6/24
to Rafael Sene, isa...@groups.riscv.org
> Regarding the PDF, you can download the PDF from the latest release

That's what I was expecting to do, but....

I went to https://github.com/riscv/riscv-dot-product . No PDF files are listed on the project page. I tried clicking on Code and downloading the .zip file, but that doesn't contain any PDF files either.

By clicking on more of the .adoc files, I now see that most of them do include content (e.g. body.adoc): the one I looked at first, readme.adoc, is just the boilerplate for how to build the .pdf file.

I can read the .adoc files easily, so I'm able to see what I want. However, I still don't see any PDF files, at least for this project.

Rafael Sene

unread,
Dec 6, 2024, 2:43:27 PM12/6/24
to L Peter Deutsch, isa...@groups.riscv.org
Fixed.

A release was missing in that specific repository.


Atenciosamente | Sincerely
Rafael Peria de Sene
Technical Program Manager, RISC-V
E-mail: raf...@riscv.org
---
I sent this email when it was convenient for me.
Please reply whenever it's good for you!

Bruce Hoult

unread,
Dec 6, 2024, 11:39:19 PM12/6/24
to L Peter Deutsch, Rafael Sene, isa...@groups.riscv.org
https://github.com/riscv/riscv-dot-product/releases/download/v0.0.1/dot-product.pdf
> --
> You received this message because you are subscribed to the Google Groups "RISC-V ISA Dev" group.
> To unsubscribe from this group and stop receiving emails from it, send an email to isa-dev+u...@groups.riscv.org.
> To view this discussion visit https://groups.google.com/a/groups.riscv.org/d/msgid/isa-dev/20241206193340.E6DBBEC2C9A%40serpent.at.major2nd.com.
Reply all
Reply to author
Forward
0 new messages