docs: update out-of-date info in README.md, docs/, and manual/
#1459
Conversation
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
We already did this in `ci.yml`, but didn't update it everywhere.
…old `nightly-2022-02-14`
…e outdated `c2rust.com`
ahomescu
requested changes
Nov 15, 2025
This recommends `bear` over `intercept-build` instead of the opposite, as it's more robust now, not Linux-only, and more up-to-date. Also, running it on clean builds is mentioned now.
`c2rust-testsuite/test.py` already is set up to use `uv`, but we also need a `uv tool install scan-build` for `intercept-build` (which is what was left in `requirements.txt`).
kkysen
force-pushed
the
kkysen/update-readme-docs-manual
branch
from
f311083 to
87eebdf
Compare
ahomescu
approved these changes
Nov 16, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This updates the
README.md,docs/, andmanual/toc2rust refactornow that it's been resurrected.rustfmt-preview, Lua scripting).godbolt.orginstead ofc2rust.com, as it's actually up-to-date and much nicer to use.bearoverintercept-build, as it's much more up-to-date and not Linux-only anymore.--locked, which we get a lot of issues about.nightly-2022-08-08, except for the generatednightly-2023-04-15, which is on purpose and up-to-date.uv, too (test_translator.pyandc2rust-testsuite/test.pyalready were, our main test scripts).It doesn't, however,
c2rust.com/manual, as I'm not sure how to do that. But theREADME.mddoes now warn thatc2rust.com/manualis currently very out-of-date and to refer to the in-tree sources instead.manual/c2rust-refactor/doc/{ldoc.css, scripting_api.html}.