Skip to content

Commit c2aa5e6

Browse files
authored
docs: update out-of-date info in README.md, docs/, and manual/ (#1459)
This updates the `README.md`, `docs/`, and `manual/` to * re-add `c2rust refactor` now that it's been resurrected. * remove known limitations that have now been fixed (inline assembly, C11 atomics, packed structs). * remove references to things that have been removed (cross-checks, Docker, Azure CI, `rustfmt-preview`, Lua scripting). * recommend `godbolt.org` instead of `c2rust.com`, as it's actually up-to-date and much nicer to use. * recommend `bear` over `intercept-build`, as it's much more up-to-date and not Linux-only anymore. * update installation instructions to use `--locked`, which we get a lot of issues about. * update all the even older nightly references to `nightly-2022-08-08`, except for the generated `nightly-2023-04-15`, which is on purpose and up-to-date. * update everything else to use `uv`, too (`test_translator.py` and `c2rust-testsuite/test.py` already were, our main test scripts). It doesn't, however, * update `c2rust.com/manual`, as I'm not sure how to do that. But the `README.md` does now warn that `c2rust.com/manual` is currently very out-of-date and to refer to the in-tree sources instead. * touch any of `manual/c2rust-refactor/doc/{ldoc.css, scripting_api.html}`. * update most dependencies. Many aren't needed or used anymore, or use the wrong versions, but determining that needs more CI testing (our main source of truth).
2 parents 4e79794 + 87eebdf commit c2aa5e6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+241
-226
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,6 @@ jobs:
9898
# It's important that we keep `RUSTFLAGS` consistent between different steps
9999
# so that we don't have to rebuild everything.
100100
echo "RUSTFLAGS=-Clink-arg=-L/opt/homebrew/lib -Clink-arg=-Wl,-rpath,/opt/homebrew/lib" >> $GITHUB_ENV
101-
102101
103102
- name: cargo build --release
104103
run: |
@@ -120,4 +119,4 @@ jobs:
120119
# causing tons of errors, so don't set that.
121120
# `test_translator.py` does not rebuild,
122121
# so changing `RUSTFLAGS` will not trigger a full rebuild.
123-
uv run ./scripts/test_translator.py tests/
122+
./scripts/test_translator.py tests/

.github/workflows/internal-testsuite.yml

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -67,11 +67,11 @@ jobs:
6767
${{ github.workspace }}/testsuite/tests/**/compile_commands.json
6868
key: ${{ runner.os }}-${{ hashFiles('**/Cargo.lock', '**/c2rust-ast-exporter/**/CMakeLists.txt', '**/examples/**/CMakeLists.txt') }}
6969

70-
- name: Cache Python - pip
71-
uses: actions/cache@v4
72-
with:
73-
path: ~/.cache/pip
74-
key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
70+
- uses: astral-sh/setup-uv@v6
71+
72+
- name: Install Python Packages
73+
run: |
74+
uv tool install scan-build # for `intercept-build`
7575
7676
# TODO(pl): Figure out why json-c fails when caching compile commands
7777
# - name: Get Image Version
@@ -88,7 +88,7 @@ jobs:
8888
# key: ${{ runner.os }}-ccdb-${{ steps.get-image-ver.outputs.version }}
8989

9090
- name: Provision Rust
91-
run: rustup component add rustfmt-preview rustc-dev
91+
run: rustup component add rustfmt rustc-dev
9292

9393
- name: Provision Debian Packages
9494
run: |
@@ -111,17 +111,11 @@ jobs:
111111
librtmp-dev \
112112
libtool \
113113
libzstd-dev \
114-
python3-setuptools \
115-
python3-wheel \
116114
rcs \
117115
tcl-dev \
118116
tk-dev \
119117
zlib1g-dev
120118
121-
# installs intercept-build to $HOME/.local/bin
122-
- name: Provision Python Packages
123-
run: python3 -m pip install -r $GITHUB_WORKSPACE/testsuite/requirements.txt
124-
125119
# Runs a single command using the runners shell
126120
# Working dir is /home/runner/work/c2rust/c2rust
127121
- name: Build c2rust
@@ -136,7 +130,7 @@ jobs:
136130
export PATH=$PWD/target/release:$HOME/.local/bin:$PATH
137131
echo "PATH=$PATH"
138132
export C2RUST_DIR=$PWD
139-
python3 testsuite/test.py curl json-c lua nginx zstd libxml2 python2
133+
./testsuite/test.py curl json-c lua nginx zstd libxml2 python2
140134
141135
- uses: actions/upload-artifact@v4
142136
with:

0 commit comments

Comments
 (0)