Update synthesis docs #454
Conversation
|
Please, check the grammar first before submitting any English text in a PR. |
Co-authored-by: Marek Materzok <[email protected]> Co-authored-by: Kristopher38 <[email protected]>
Co-authored-by: Marek Materzok <[email protected]>
docs/synthesis/Synthesis.md
Outdated
| cd coreblocks | ||
| git submodule update --init --recursive | ||
| cd .. | ||
| sudo docker pull ghcr.io/kuznia-rdzeni/riscv-toolchain:2023.10.08_v |
There was a problem hiding this comment.
I suggest having a latest tag to avoid updating this doc on every docker change. This needs to be changed on other lines too.
| sudo docker pull ghcr.io/kuznia-rdzeni/riscv-toolchain:2023.10.08_v | |
| sudo docker pull ghcr.io/kuznia-rdzeni/riscv-toolchain:latest |
There was a problem hiding this comment.
But we don't use the tag latest.
sudo docker pull ghcr.io/kuznia-rdzeni/riscv-toolchain:latestThat command doesn't work.
There was a problem hiding this comment.
No, we don't. Maybe we should? (That was the suggestion.)
There was a problem hiding this comment.
Maybe we should have two sets of tags? One to use in pipelines to allow easy tracking of changes and second tag latest for the documentation? Or maybe we should use only the latest tag and use checksums in pipelines?
I don't want to use latest in pipelines, because that will cause some tricky errors (e.g. updating dockers in preparation for Dockerfile change, while some other review is being tested).
There was a problem hiding this comment.
I have added latest tag to verilog and amaranth-synth packages. To add tag to the riscv-toolchain I have to download it first.
There was a problem hiding this comment.
riscv-toolchain have been also tagged with latest
There was a problem hiding this comment.
I don't want to use latest in pipelines, because that will cause some tricky errors (e.g. updating dockers in preparation for Dockerfile change, while some other review is being tested).
Workflows should reference concrete versions, latest should be for convenience only.
…eni/coreblocks into lekcyjna/update-synthesis-doc
…eni/coreblocks into lekcyjna/update-synthesis-doc
|
@Kristopher38 Could you do a second review? |
Co-authored-by: Marek Materzok <[email protected]> Co-authored-by: Kristopher38 <[email protected]>
I have found today that our synthesis page in documentation is a little bit out-of-date, so I updated it by adding information how to use our pre-build docker image.