[doc] Improve dev guide#554
Open
elliotb-lowrisc wants to merge 1 commit into
Open
Conversation
Contributor
Author
|
I intend to make this PR non-draft when I have had a chance to try the new FPGA commands |
Several updates and improvements to the dev guide: - Update out-of-date commands. - Add commands for running SW on FPGA. - Add options to Verilator build command to improve build/sim runtime. - Document temperature sensor connections. - Add some useful alternative commands. - Clarify the use of the "_sram" SW binary suffix. - Other minor textural improvements.
engdoreis
reviewed
May 15, 2026
| cmake --build build/sw -j $(nproc) | ||
| ``` | ||
|
|
||
| Outputs with the suffix "_sram" exist only for UVM-based tests, as they lack a DRAM backdoor-load mechanism. |
Collaborator
There was a problem hiding this comment.
I'm concern that this will be left behind when the _sram binaries are dropped.
If you wan't to keep this, please add item to the issue to clean up the documentation.
| ### Code Quality | ||
|
|
||
| For software written in C, `clang-format` and `clang-tidy` are used format and lint the code. Wrapper scripts to run these on all C files in the project are provided for convenience. | ||
| For software written in C, `clang-format` and `clang-tidy` are used format and lint the code. |
Collaborator
There was a problem hiding this comment.
Suggested change
| For software written in C, `clang-format` and `clang-tidy` are used format and lint the code. | |
| For software written in C, `clang-format` and `clang-tidy` are used to format and lint the code. |
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.
Several updates and improvements to the dev guide: