[doc] Fixes and improvements for the ot-sku documentation - #22
Merged
Merged
Conversation
Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
These can be added with comments which aren't rendered by Github and the vast majority of modern Markdown renderers - so no reason not to add them to these files as well, even if not strictly checked. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
pamaury
reviewed
Sep 14, 2026
pamaury
requested changes
Sep 14, 2026
pamaury
left a comment
pamaury
left a comment
Collaborator
There was a problem hiding this comment.
Thanks @AlexJones0 , that's a nice improvement. There is a little thing about using the repository where the documentation is not up to date (blame me for forgetting to update it), it would be nice if you can update it at the same time.
* Fix the override mechanism to point to the newer `override_module` flow instead of the legacy `PROV_EXTS_DIR` flow. * More links where relevant. * Switch recommendation from `bazel` to `bazelisk`, and point out dependencies on OpenTitan repository if you want to manually run the CI flows. * Example should be performed from the `earlgrey_1.0.0` branch. * Link to Github release documentation, as this is the really important part. * Point towards where you can acquire hsmtool, with a note on the current transition (intended to be deprecated in the near future). * Add a quick link to the existing in-tree SoftHSMv2 documentation, but note that this is for testing flows only and not intended for real release flows. * Add some extra information on licensing and further links. Also fix the Markdown styling to conform to one-sentence-per-line. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
* Fix broken relative link to the release flow. * Minor grammar fixes. * Fix Markdown styling to be one sentence per line. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
AlexJones0
force-pushed
the
doc_improvements
branch
from
September 14, 2026 11:47
0b1bf51 to
6202006
Compare
pamaury
approved these changes
Sep 14, 2026
* Add styling to make warnings stand out a bit more. * Make the step 2 instructions more rigorous; specifically define the SKU that is being used to avoid path issues, capture the `OT_SKU_PATH` and `HSMTOOL` path in environment variables to make it easier to directly copy commands. * Make sure that the signatures are actually staged, and add a note about forcefully overriding the .gitignore. Also make the note about adding a signing log more explicit. * Add a short section at the end on troubleshooting with advice for common problems that have already been seen, or problems that we anticipate it might be likely to see in the future. * Fix grammar & typos in some places. * Fix markdown styling to be one sentence per line. Signed-off-by: Alex Jones <alex.jones@lowrisc.org>
AlexJones0
force-pushed
the
doc_improvements
branch
from
September 14, 2026 14:44
6202006 to
235d9ba
Compare
AlexJones0
commented
Sep 14, 2026
| popd | ||
| pushd presign_rom_ext | ||
| /path/to/hsmtool $HSMTOOL_CUSTOM_ARG exec rom_ext.json | ||
| $HSMTOOL $HSMTOOL_CUSTOM_ARG exec rom_ext.json |
Contributor
Author
There was a problem hiding this comment.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A pass over and improvement of most of the key documentation already checked into
ot-sku:README.mdwith relevant links, guidance on where to look for information if you run into problems, etc.See the individual commit messages for more details.