search

riscv / riscv-crypto

RISC-V cryptography extensions standardisation work.
https://wiki.riscv.org/x/MVcF
Creative Commons Attribution 4.0 International
359 stars 83 forks source link

Incorrect information in Vector Crypto Specification Release 1.0.0 #387

Open michaelmaitland opened 5 months ago

michaelmaitland commented 5 months ago

I downloaded the PDF from the Vector Crypto Specification Release 1.0.0 and noticed it had the typo that had been fixed in https://github.com/riscv/riscv-crypto/commit/ae384d56a4e70d8f5279777ce9898a697ab1a0c3.

Is there the ability to fix this in the generated PDF? I understand there's been a big effort recently to merge all ratified extensions into riscv-isa-manual (where it is fixed), but I think it should still be fixed here, especially since that code change has been committed.

nibrunieAtSi5 commented 5 months ago

This repo has been archived and I am not sure we are going to generate a new spec from it. It might be clearer to remove the release version from here and points to the main repo. @wmat, @kdockser ?

michaelmaitland commented 5 months ago

It might be clearer to remove the release version from here and points to the main repo. @wmat, @kdockser ?

That might be a good idea. This is the first result for a google search on risc-v vector crypto spec and there isn't much leading me to riscv-isa-manual once I click into the repo. Instead I found myself in the release pdf, believing this is the correct way to access the up to date spec.

wmat commented 5 months ago

I'm not exactly sure the best way to do this. I could add a link to riscv-isa-manual in the README. But are you asking me to remove the last 1.0.0 release?

michaelmaitland commented 5 months ago

I could add a link to riscv-isa-manual in the README

Given that the 1.0.0 release is not the same as what is checked in the repo and that we don't plan to fix 1.0.0 release or put out a new one in this repo, I wouldn't be against removing the last release.

That being said, if the README said that the 1.0.0 release is not up to date with the code in the repo and to use riscv-isa-manual instead, that would have been enough to make me go read the riscv-isa-manual which does not have the error.