Rollup merge of #144049 - tshepang:rust-push, r=jieyouxu
rustc-dev-guide subtree update r? ghost
This commit is contained in:
Matthias Krüger
GitHub
commit
37e7bc1296
15 changed files with 157 additions and 989 deletions
|
|
@ -9,106 +9,12 @@ on:
|
|||
jobs:
|
||||
pull:
|
||||
if: github.repository == 'rust-lang/rustc-dev-guide'
|
||||
runs-on: ubuntu-latest
|
||||
outputs:
|
||||
pr_url: ${{ steps.update-pr.outputs.pr_url }}
|
||||
permissions:
|
||||
contents: write
|
||||
pull-requests: write
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
# We need the full history for josh to work
|
||||
fetch-depth: '0'
|
||||
- name: Install stable Rust toolchain
|
||||
run: rustup update stable
|
||||
- uses: Swatinem/rust-cache@v2
|
||||
with:
|
||||
workspaces: "josh-sync"
|
||||
# Cache the josh directory with checked out rustc
|
||||
cache-directories: "/home/runner/.cache/rustc-dev-guide-josh"
|
||||
- name: Install josh
|
||||
run: RUSTFLAGS="--cap-lints warn" cargo install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
|
||||
- name: Setup bot git name and email
|
||||
run: |
|
||||
git config --global user.name 'The rustc-dev-guide Cronjob Bot'
|
||||
git config --global user.email 'github-actions@github.com'
|
||||
- name: Perform rustc-pull
|
||||
id: rustc-pull
|
||||
# Turn off -e to disable early exit
|
||||
shell: bash {0}
|
||||
run: |
|
||||
cargo run --manifest-path josh-sync/Cargo.toml -- rustc-pull
|
||||
exitcode=$?
|
||||
|
||||
# If no pull was performed, we want to mark this job as successful,
|
||||
# but we do not want to perform the follow-up steps.
|
||||
if [ $exitcode -eq 0 ]; then
|
||||
echo "pull_result=pull-finished" >> $GITHUB_OUTPUT
|
||||
elif [ $exitcode -eq 2 ]; then
|
||||
echo "pull_result=skipped" >> $GITHUB_OUTPUT
|
||||
exitcode=0
|
||||
fi
|
||||
|
||||
exit ${exitcode}
|
||||
- name: Push changes to a branch
|
||||
if: ${{ steps.rustc-pull.outputs.pull_result == 'pull-finished' }}
|
||||
run: |
|
||||
# Update a sticky branch that is used only for rustc pulls
|
||||
BRANCH="rustc-pull"
|
||||
git switch -c $BRANCH
|
||||
git push -u origin $BRANCH --force
|
||||
- name: Create pull request
|
||||
id: update-pr
|
||||
if: ${{ steps.rustc-pull.outputs.pull_result == 'pull-finished' }}
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
# Check if an open pull request for an rustc pull update already exists
|
||||
# If it does, the previous push has just updated it
|
||||
# If not, we create it now
|
||||
RESULT=`gh pr list --author github-actions[bot] --state open -q 'map(select(.title=="Rustc pull update")) | length' --json title`
|
||||
if [[ "$RESULT" -eq 0 ]]; then
|
||||
echo "Creating new pull request"
|
||||
PR_URL=`gh pr create -B master --title 'Rustc pull update' --body 'Latest update from rustc.'`
|
||||
echo "pr_url=$PR_URL" >> $GITHUB_OUTPUT
|
||||
else
|
||||
PR_URL=`gh pr list --author github-actions[bot] --state open -q 'map(select(.title=="Rustc pull update")) | .[0].url' --json url,title`
|
||||
echo "Updating pull request ${PR_URL}"
|
||||
echo "pr_url=$PR_URL" >> $GITHUB_OUTPUT
|
||||
fi
|
||||
send-zulip-message:
|
||||
needs: [pull]
|
||||
if: ${{ !cancelled() }}
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
- name: Compute message
|
||||
id: create-message
|
||||
env:
|
||||
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
||||
run: |
|
||||
if [ "${{ needs.pull.result }}" == "failure" ]; then
|
||||
WORKFLOW_URL="${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}"
|
||||
echo "message=Rustc pull sync failed. Check out the [workflow URL]($WORKFLOW_URL)." >> $GITHUB_OUTPUT
|
||||
else
|
||||
CREATED_AT=`gh pr list --author github-actions[bot] --state open -q 'map(select(.title=="Rustc pull update")) | .[0].createdAt' --json createdAt,title`
|
||||
PR_URL=`gh pr list --author github-actions[bot] --state open -q 'map(select(.title=="Rustc pull update")) | .[0].url' --json url,title`
|
||||
week_ago=$(date +%F -d '7 days ago')
|
||||
|
||||
# If there is an open PR that is at least a week old, post a message about it
|
||||
if [[ -n $DATE_GH && $DATE_GH < $week_ago ]]; then
|
||||
echo "message=A PR with a Rustc pull has been opened for more a week. Check out the [PR](${PR_URL})." >> $GITHUB_OUTPUT
|
||||
fi
|
||||
fi
|
||||
- name: Send a Zulip message about updated PR
|
||||
if: ${{ steps.create-message.outputs.message != '' }}
|
||||
uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5
|
||||
with:
|
||||
api-key: ${{ secrets.ZULIP_API_TOKEN }}
|
||||
email: "rustc-dev-guide-gha-notif-bot@rust-lang.zulipchat.com"
|
||||
organization-url: "https://rust-lang.zulipchat.com"
|
||||
to: 196385
|
||||
type: "stream"
|
||||
topic: "Subtree sync automation"
|
||||
content: ${{ steps.create-message.outputs.message }}
|
||||
uses: rust-lang/josh-sync/.github/workflows/rustc-pull.yml@main
|
||||
with:
|
||||
zulip-stream-id: 196385
|
||||
zulip-bot-email: "rustc-dev-guide-gha-notif-bot@rust-lang.zulipchat.com"
|
||||
pr-base-branch: master
|
||||
branch-name: rustc-pull
|
||||
secrets:
|
||||
zulip-api-token: ${{ secrets.ZULIP_API_TOKEN }}
|
||||
token: ${{ secrets.GITHUB_TOKEN }}
|
||||
|
|
|
|||
|
|
@ -72,49 +72,6 @@ including the `<!-- toc -->` marker at the place where you want the TOC.
|
|||
|
||||
## Synchronizing josh subtree with rustc
|
||||
|
||||
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the following commands to synchronize the subtree in both directions.
|
||||
This repository is linked to `rust-lang/rust` as a [josh](https://josh-project.github.io/josh/intro.html) subtree. You can use the [rustc-josh-sync](https://github.com/rust-lang/josh-sync) tool to perform synchronization.
|
||||
|
||||
You'll need to install `josh-proxy` locally via
|
||||
|
||||
```
|
||||
cargo install josh-proxy --git https://github.com/josh-project/josh --tag r24.10.04
|
||||
```
|
||||
Older versions of `josh-proxy` may not round trip commits losslessly so it is important to install this exact version.
|
||||
|
||||
### Pull changes from `rust-lang/rust` into this repository
|
||||
|
||||
1) Checkout a new branch that will be used to create a PR into `rust-lang/rustc-dev-guide`
|
||||
2) Run the pull command
|
||||
```
|
||||
cargo run --manifest-path josh-sync/Cargo.toml rustc-pull
|
||||
```
|
||||
3) Push the branch to your fork and create a PR into `rustc-dev-guide`
|
||||
|
||||
### Push changes from this repository into `rust-lang/rust`
|
||||
|
||||
NOTE: If you use Git protocol to push to your fork of `rust-lang/rust`,
|
||||
ensure that you have this entry in your Git config,
|
||||
else the 2 steps that follow would prompt for a username and password:
|
||||
|
||||
```
|
||||
[url "git@github.com:"]
|
||||
insteadOf = "https://github.com/"
|
||||
```
|
||||
|
||||
1) Run the push command to create a branch named `<branch-name>` in a `rustc` fork under the `<gh-username>` account
|
||||
```
|
||||
cargo run --manifest-path josh-sync/Cargo.toml rustc-push <branch-name> <gh-username>
|
||||
```
|
||||
2) Create a PR from `<branch-name>` into `rust-lang/rust`
|
||||
|
||||
#### Minimal git config
|
||||
|
||||
For simplicity (ease of implementation purposes), the josh-sync script simply calls out to system git. This means that the git invocation may be influenced by global (or local) git configuration.
|
||||
|
||||
You may observe "Nothing to pull" even if you *know* rustc-pull has something to pull if your global git config sets `fetch.prunetags = true` (and possibly other configurations may cause unexpected outcomes).
|
||||
|
||||
To minimize the likelihood of this happening, you may wish to keep a separate *minimal* git config that *only* has `[user]` entries from global git config, then repoint system git to use the minimal git config instead. E.g.
|
||||
|
||||
```
|
||||
GIT_CONFIG_GLOBAL=/path/to/minimal/gitconfig GIT_CONFIG_SYSTEM='' cargo run --manifest-path josh-sync/Cargo.toml -- rustc-pull
|
||||
```
|
||||
You can find a guide on how to perform the synchronization [here](./src/external-repos.md#synchronizing-a-josh-subtree).
|
||||
|
|
|
|||
|
|
@ -1,430 +0,0 @@
|
|||
# This file is automatically @generated by Cargo.
|
||||
# It is not intended for manual editing.
|
||||
version = 4
|
||||
|
||||
[[package]]
|
||||
name = "anstream"
|
||||
version = "0.6.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8acc5369981196006228e28809f761875c0327210a891e941f4c683b3a99529b"
|
||||
dependencies = [
|
||||
"anstyle",
|
||||
"anstyle-parse",
|
||||
"anstyle-query",
|
||||
"anstyle-wincon",
|
||||
"colorchoice",
|
||||
"is_terminal_polyfill",
|
||||
"utf8parse",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle"
|
||||
version = "1.0.10"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "55cc3b69f167a1ef2e161439aa98aed94e6028e5f9a59be9a6ffb47aef1651f9"
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-parse"
|
||||
version = "0.2.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3b2d16507662817a6a20a9ea92df6652ee4f94f914589377d69f3b21bc5798a9"
|
||||
dependencies = [
|
||||
"utf8parse",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-query"
|
||||
version = "1.1.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "79947af37f4177cfead1110013d678905c37501914fba0efea834c3fe9a8d60c"
|
||||
dependencies = [
|
||||
"windows-sys 0.59.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anstyle-wincon"
|
||||
version = "3.0.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2109dbce0e72be3ec00bed26e6a7479ca384ad226efdd66db8fa2e3a38c83125"
|
||||
dependencies = [
|
||||
"anstyle",
|
||||
"windows-sys 0.59.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "anyhow"
|
||||
version = "1.0.95"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "34ac096ce696dc2fcabef30516bb13c0a68a11d30131d3df6f04711467681b04"
|
||||
|
||||
[[package]]
|
||||
name = "bitflags"
|
||||
version = "2.6.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
|
||||
|
||||
[[package]]
|
||||
name = "cfg-if"
|
||||
version = "1.0.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd"
|
||||
|
||||
[[package]]
|
||||
name = "clap"
|
||||
version = "4.5.23"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "3135e7ec2ef7b10c6ed8950f0f792ed96ee093fa088608f1c76e569722700c84"
|
||||
dependencies = [
|
||||
"clap_builder",
|
||||
"clap_derive",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_builder"
|
||||
version = "4.5.23"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "30582fc632330df2bd26877bde0c1f4470d57c582bbc070376afcd04d8cb4838"
|
||||
dependencies = [
|
||||
"anstream",
|
||||
"anstyle",
|
||||
"clap_lex",
|
||||
"strsim",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_derive"
|
||||
version = "4.5.18"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4ac6a0c7b1a9e9a5186361f67dfa1b88213572f427fb9ab038efb2bd8c582dab"
|
||||
dependencies = [
|
||||
"heck",
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "clap_lex"
|
||||
version = "0.7.4"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "f46ad14479a25103f283c0f10005961cf086d8dc42205bb44c46ac563475dca6"
|
||||
|
||||
[[package]]
|
||||
name = "colorchoice"
|
||||
version = "1.0.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "5b63caa9aa9397e2d9480a9b13673856c78d8ac123288526c37d7839f2a86990"
|
||||
|
||||
[[package]]
|
||||
name = "directories"
|
||||
version = "5.0.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9a49173b84e034382284f27f1af4dcbbd231ffa358c0fe316541a7337f376a35"
|
||||
dependencies = [
|
||||
"dirs-sys",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "dirs-sys"
|
||||
version = "0.4.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "520f05a5cbd335fae5a99ff7a6ab8627577660ee5cfd6a94a6a929b52ff0321c"
|
||||
dependencies = [
|
||||
"libc",
|
||||
"option-ext",
|
||||
"redox_users",
|
||||
"windows-sys 0.48.0",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "getrandom"
|
||||
version = "0.2.15"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c4567c8db10ae91089c99af84c68c38da3ec2f087c3f82960bcdbf3656b6f4d7"
|
||||
dependencies = [
|
||||
"cfg-if",
|
||||
"libc",
|
||||
"wasi",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "heck"
|
||||
version = "0.5.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea"
|
||||
|
||||
[[package]]
|
||||
name = "is_terminal_polyfill"
|
||||
version = "1.70.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7943c866cc5cd64cbc25b2e01621d07fa8eb2a1a23160ee81ce38704e97b8ecf"
|
||||
|
||||
[[package]]
|
||||
name = "josh-sync"
|
||||
version = "0.0.0"
|
||||
dependencies = [
|
||||
"anyhow",
|
||||
"clap",
|
||||
"directories",
|
||||
"xshell",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "libc"
|
||||
version = "0.2.169"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b5aba8db14291edd000dfcc4d620c7ebfb122c613afb886ca8803fa4e128a20a"
|
||||
|
||||
[[package]]
|
||||
name = "libredox"
|
||||
version = "0.1.3"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d"
|
||||
dependencies = [
|
||||
"bitflags",
|
||||
"libc",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "option-ext"
|
||||
version = "0.2.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d"
|
||||
|
||||
[[package]]
|
||||
name = "proc-macro2"
|
||||
version = "1.0.92"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "37d3544b3f2748c54e147655edb5025752e2303145b5aefb3c3ea2c78b973bb0"
|
||||
dependencies = [
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "quote"
|
||||
version = "1.0.38"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0e4dccaaaf89514f546c693ddc140f729f958c247918a13380cccc6078391acc"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "redox_users"
|
||||
version = "0.4.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43"
|
||||
dependencies = [
|
||||
"getrandom",
|
||||
"libredox",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "strsim"
|
||||
version = "0.11.1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "7da8b5736845d9f2fcb837ea5d9e2628564b3b043a70948a3f0b778838c5fb4f"
|
||||
|
||||
[[package]]
|
||||
name = "syn"
|
||||
version = "2.0.93"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9c786062daee0d6db1132800e623df74274a0a87322d8e183338e01b3d98d058"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"unicode-ident",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "thiserror"
|
||||
version = "1.0.69"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52"
|
||||
dependencies = [
|
||||
"thiserror-impl",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "thiserror-impl"
|
||||
version = "1.0.69"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1"
|
||||
dependencies = [
|
||||
"proc-macro2",
|
||||
"quote",
|
||||
"syn",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "unicode-ident"
|
||||
version = "1.0.14"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "adb9e6ca4f869e1180728b7950e35922a7fc6397f7b641499e8f3ef06e50dc83"
|
||||
|
||||
[[package]]
|
||||
name = "utf8parse"
|
||||
version = "0.2.2"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
|
||||
|
||||
[[package]]
|
||||
name = "wasi"
|
||||
version = "0.11.0+wasi-snapshot-preview1"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423"
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.48.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "677d2418bec65e3338edb076e806bc1ec15693c5d0104683f2efe857f61056a9"
|
||||
dependencies = [
|
||||
"windows-targets 0.48.5",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-sys"
|
||||
version = "0.59.0"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "1e38bc4d79ed67fd075bcc251a1c39b32a1776bbe92e5bef1f0bf1f8c531853b"
|
||||
dependencies = [
|
||||
"windows-targets 0.52.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-targets"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9a2fa6e2155d7247be68c096456083145c183cbbbc2764150dda45a87197940c"
|
||||
dependencies = [
|
||||
"windows_aarch64_gnullvm 0.48.5",
|
||||
"windows_aarch64_msvc 0.48.5",
|
||||
"windows_i686_gnu 0.48.5",
|
||||
"windows_i686_msvc 0.48.5",
|
||||
"windows_x86_64_gnu 0.48.5",
|
||||
"windows_x86_64_gnullvm 0.48.5",
|
||||
"windows_x86_64_msvc 0.48.5",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows-targets"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9b724f72796e036ab90c1021d4780d4d3d648aca59e491e6b98e725b84e99973"
|
||||
dependencies = [
|
||||
"windows_aarch64_gnullvm 0.52.6",
|
||||
"windows_aarch64_msvc 0.52.6",
|
||||
"windows_i686_gnu 0.52.6",
|
||||
"windows_i686_gnullvm",
|
||||
"windows_i686_msvc 0.52.6",
|
||||
"windows_x86_64_gnu 0.52.6",
|
||||
"windows_x86_64_gnullvm 0.52.6",
|
||||
"windows_x86_64_msvc 0.52.6",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_gnullvm"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "2b38e32f0abccf9987a4e3079dfb67dcd799fb61361e53e2882c3cbaf0d905d8"
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3"
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_msvc"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "dc35310971f3b2dbbf3f0690a219f40e2d9afcf64f9ab7cc1be722937c26b4bc"
|
||||
|
||||
[[package]]
|
||||
name = "windows_aarch64_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_gnu"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "a75915e7def60c94dcef72200b9a8e58e5091744960da64ec734a6c6e9b3743e"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_gnu"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_msvc"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "8f55c233f70c4b27f66c523580f78f1004e8b5a8b659e05a4eb49d4166cca406"
|
||||
|
||||
[[package]]
|
||||
name = "windows_i686_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnu"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "53d40abd2583d23e4718fddf1ebec84dbff8381c07cae67ff7768bbf19c6718e"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnu"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnullvm"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "0b7b52767868a23d5bab768e390dc5f5c55825b6d30b86c844ff2dc7414044cc"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_gnullvm"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_msvc"
|
||||
version = "0.48.5"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "ed94fce61571a4006852b7389a063ab983c02eb1bb37b47f8272ce92d06d9538"
|
||||
|
||||
[[package]]
|
||||
name = "windows_x86_64_msvc"
|
||||
version = "0.52.6"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec"
|
||||
|
||||
[[package]]
|
||||
name = "xshell"
|
||||
version = "0.2.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "9e7290c623014758632efe00737145b6867b66292c42167f2ec381eb566a373d"
|
||||
dependencies = [
|
||||
"xshell-macros",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "xshell-macros"
|
||||
version = "0.2.7"
|
||||
source = "registry+https://github.com/rust-lang/crates.io-index"
|
||||
checksum = "32ac00cd3f8ec9c1d33fb3e7958a82df6989c42d747bd326c822b1d625283547"
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
[package]
|
||||
name = "josh-sync"
|
||||
edition = "2024"
|
||||
|
||||
[dependencies]
|
||||
anyhow = "1.0.95"
|
||||
clap = { version = "4.5.21", features = ["derive"] }
|
||||
directories = "5"
|
||||
xshell = "0.2.6"
|
||||
|
|
@ -1,4 +0,0 @@
|
|||
# Git josh sync
|
||||
This utility serves for syncing the josh git subtree to and from the rust-lang/rust repository.
|
||||
|
||||
See CLI help for usage.
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
use clap::Parser;
|
||||
|
||||
use crate::sync::{GitSync, RustcPullError};
|
||||
|
||||
mod sync;
|
||||
|
||||
#[derive(clap::Parser)]
|
||||
enum Args {
|
||||
/// Pull changes from the main `rustc` repository.
|
||||
/// This creates new commits that should be then merged into `rustc-dev-guide`.
|
||||
RustcPull,
|
||||
/// Push changes from `rustc-dev-guide` to the given `branch` of a `rustc` fork under the given
|
||||
/// GitHub `username`.
|
||||
/// The pushed branch should then be merged into the `rustc` repository.
|
||||
RustcPush { branch: String, github_username: String },
|
||||
}
|
||||
|
||||
fn main() -> anyhow::Result<()> {
|
||||
let args = Args::parse();
|
||||
let sync = GitSync::from_current_dir()?;
|
||||
match args {
|
||||
Args::RustcPull => {
|
||||
if let Err(error) = sync.rustc_pull(None) {
|
||||
match error {
|
||||
RustcPullError::NothingToPull => {
|
||||
eprintln!("Nothing to pull");
|
||||
std::process::exit(2);
|
||||
}
|
||||
RustcPullError::PullFailed(error) => {
|
||||
eprintln!("Pull failure: {error:?}");
|
||||
std::process::exit(1);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
Args::RustcPush { github_username, branch } => {
|
||||
sync.rustc_push(github_username, branch)?;
|
||||
}
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
|
@ -1,275 +0,0 @@
|
|||
use std::io::Write;
|
||||
use std::ops::Not;
|
||||
use std::path::PathBuf;
|
||||
use std::time::Duration;
|
||||
use std::{env, net, process};
|
||||
|
||||
use anyhow::{Context, anyhow, bail};
|
||||
use xshell::{Shell, cmd};
|
||||
|
||||
/// Used for rustc syncs.
|
||||
const JOSH_FILTER: &str = ":/src/doc/rustc-dev-guide";
|
||||
const JOSH_PORT: u16 = 42042;
|
||||
const UPSTREAM_REPO: &str = "rust-lang/rust";
|
||||
|
||||
pub enum RustcPullError {
|
||||
/// No changes are available to be pulled.
|
||||
NothingToPull,
|
||||
/// A rustc-pull has failed, probably a git operation error has occurred.
|
||||
PullFailed(anyhow::Error),
|
||||
}
|
||||
|
||||
impl<E> From<E> for RustcPullError
|
||||
where
|
||||
E: Into<anyhow::Error>,
|
||||
{
|
||||
fn from(error: E) -> Self {
|
||||
Self::PullFailed(error.into())
|
||||
}
|
||||
}
|
||||
|
||||
pub struct GitSync {
|
||||
dir: PathBuf,
|
||||
}
|
||||
|
||||
/// This code was adapted from the miri repository
|
||||
/// (https://github.com/rust-lang/miri/blob/6a68a79f38064c3bc30617cca4bdbfb2c336b140/miri-script/src/commands.rs#L236).
|
||||
impl GitSync {
|
||||
pub fn from_current_dir() -> anyhow::Result<Self> {
|
||||
Ok(Self { dir: std::env::current_dir()? })
|
||||
}
|
||||
|
||||
pub fn rustc_pull(&self, commit: Option<String>) -> Result<(), RustcPullError> {
|
||||
let sh = Shell::new()?;
|
||||
sh.change_dir(&self.dir);
|
||||
let commit = commit.map(Ok).unwrap_or_else(|| {
|
||||
let rust_repo_head =
|
||||
cmd!(sh, "git ls-remote https://github.com/{UPSTREAM_REPO}/ HEAD").read()?;
|
||||
rust_repo_head
|
||||
.split_whitespace()
|
||||
.next()
|
||||
.map(|front| front.trim().to_owned())
|
||||
.ok_or_else(|| anyhow!("Could not obtain Rust repo HEAD from remote."))
|
||||
})?;
|
||||
// Make sure the repo is clean.
|
||||
if cmd!(sh, "git status --untracked-files=no --porcelain").read()?.is_empty().not() {
|
||||
return Err(anyhow::anyhow!(
|
||||
"working directory must be clean before performing rustc pull"
|
||||
)
|
||||
.into());
|
||||
}
|
||||
// Make sure josh is running.
|
||||
let josh = Self::start_josh()?;
|
||||
let josh_url =
|
||||
format!("http://localhost:{JOSH_PORT}/{UPSTREAM_REPO}.git@{commit}{JOSH_FILTER}.git");
|
||||
|
||||
let previous_base_commit = sh.read_file("rust-version")?.trim().to_string();
|
||||
if previous_base_commit == commit {
|
||||
return Err(RustcPullError::NothingToPull);
|
||||
}
|
||||
|
||||
// Update rust-version file. As a separate commit, since making it part of
|
||||
// the merge has confused the heck out of josh in the past.
|
||||
// We pass `--no-verify` to avoid running git hooks.
|
||||
// We do this before the merge so that if there are merge conflicts, we have
|
||||
// the right rust-version file while resolving them.
|
||||
sh.write_file("rust-version", format!("{commit}\n"))?;
|
||||
const PREPARING_COMMIT_MESSAGE: &str = "Preparing for merge from rustc";
|
||||
cmd!(sh, "git commit rust-version --no-verify -m {PREPARING_COMMIT_MESSAGE}")
|
||||
.run()
|
||||
.context("FAILED to commit rust-version file, something went wrong")?;
|
||||
|
||||
// Fetch given rustc commit.
|
||||
cmd!(sh, "git fetch {josh_url}")
|
||||
.run()
|
||||
.inspect_err(|_| {
|
||||
// Try to un-do the previous `git commit`, to leave the repo in the state we found it.
|
||||
cmd!(sh, "git reset --hard HEAD^")
|
||||
.run()
|
||||
.expect("FAILED to clean up again after failed `git fetch`, sorry for that");
|
||||
})
|
||||
.context("FAILED to fetch new commits, something went wrong (committing the rust-version file has been undone)")?;
|
||||
|
||||
// This should not add any new root commits. So count those before and after merging.
|
||||
let num_roots = || -> anyhow::Result<u32> {
|
||||
Ok(cmd!(sh, "git rev-list HEAD --max-parents=0 --count")
|
||||
.read()
|
||||
.context("failed to determine the number of root commits")?
|
||||
.parse::<u32>()?)
|
||||
};
|
||||
let num_roots_before = num_roots()?;
|
||||
|
||||
let sha =
|
||||
cmd!(sh, "git rev-parse HEAD").output().context("FAILED to get current commit")?.stdout;
|
||||
|
||||
// Merge the fetched commit.
|
||||
const MERGE_COMMIT_MESSAGE: &str = "Merge from rustc";
|
||||
cmd!(sh, "git merge FETCH_HEAD --no-verify --no-ff -m {MERGE_COMMIT_MESSAGE}")
|
||||
.run()
|
||||
.context("FAILED to merge new commits, something went wrong")?;
|
||||
|
||||
let current_sha =
|
||||
cmd!(sh, "git rev-parse HEAD").output().context("FAILED to get current commit")?.stdout;
|
||||
if current_sha == sha {
|
||||
cmd!(sh, "git reset --hard HEAD^")
|
||||
.run()
|
||||
.expect("FAILED to clean up after creating the preparation commit");
|
||||
eprintln!(
|
||||
"No merge was performed, no changes to pull were found. Rolled back the preparation commit."
|
||||
);
|
||||
return Err(RustcPullError::NothingToPull);
|
||||
}
|
||||
|
||||
// Check that the number of roots did not increase.
|
||||
if num_roots()? != num_roots_before {
|
||||
return Err(anyhow::anyhow!(
|
||||
"Josh created a new root commit. This is probably not the history you want."
|
||||
)
|
||||
.into());
|
||||
}
|
||||
|
||||
drop(josh);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
pub fn rustc_push(&self, github_user: String, branch: String) -> anyhow::Result<()> {
|
||||
let sh = Shell::new()?;
|
||||
sh.change_dir(&self.dir);
|
||||
let base = sh.read_file("rust-version")?.trim().to_owned();
|
||||
// Make sure the repo is clean.
|
||||
if cmd!(sh, "git status --untracked-files=no --porcelain").read()?.is_empty().not() {
|
||||
bail!("working directory must be clean before running `rustc-push`");
|
||||
}
|
||||
// Make sure josh is running.
|
||||
let josh = Self::start_josh()?;
|
||||
let josh_url =
|
||||
format!("http://localhost:{JOSH_PORT}/{github_user}/rust.git{JOSH_FILTER}.git");
|
||||
|
||||
// Find a repo we can do our preparation in.
|
||||
if let Ok(rustc_git) = env::var("RUSTC_GIT") {
|
||||
// If rustc_git is `Some`, we'll use an existing fork for the branch updates.
|
||||
sh.change_dir(rustc_git);
|
||||
} else {
|
||||
// Otherwise, do this in the local repo.
|
||||
println!(
|
||||
"This will pull a copy of the rust-lang/rust history into this checkout, growing it by about 1GB."
|
||||
);
|
||||
print!(
|
||||
"To avoid that, abort now and set the `RUSTC_GIT` environment variable to an existing rustc checkout. Proceed? [y/N] "
|
||||
);
|
||||
std::io::stdout().flush()?;
|
||||
let mut answer = String::new();
|
||||
std::io::stdin().read_line(&mut answer)?;
|
||||
if answer.trim().to_lowercase() != "y" {
|
||||
std::process::exit(1);
|
||||
}
|
||||
};
|
||||
// Prepare the branch. Pushing works much better if we use as base exactly
|
||||
// the commit that we pulled from last time, so we use the `rust-version`
|
||||
// file to find out which commit that would be.
|
||||
println!("Preparing {github_user}/rust (base: {base})...");
|
||||
if cmd!(sh, "git fetch https://github.com/{github_user}/rust {branch}")
|
||||
.ignore_stderr()
|
||||
.read()
|
||||
.is_ok()
|
||||
{
|
||||
println!(
|
||||
"The branch '{branch}' seems to already exist in 'https://github.com/{github_user}/rust'. Please delete it and try again."
|
||||
);
|
||||
std::process::exit(1);
|
||||
}
|
||||
cmd!(sh, "git fetch https://github.com/{UPSTREAM_REPO} {base}").run()?;
|
||||
cmd!(sh, "git push https://github.com/{github_user}/rust {base}:refs/heads/{branch}")
|
||||
.ignore_stdout()
|
||||
.ignore_stderr() // silence the "create GitHub PR" message
|
||||
.run()?;
|
||||
println!();
|
||||
|
||||
// Do the actual push.
|
||||
sh.change_dir(&self.dir);
|
||||
println!("Pushing changes...");
|
||||
cmd!(sh, "git push {josh_url} HEAD:{branch}").run()?;
|
||||
println!();
|
||||
|
||||
// Do a round-trip check to make sure the push worked as expected.
|
||||
cmd!(sh, "git fetch {josh_url} {branch}").ignore_stderr().read()?;
|
||||
let head = cmd!(sh, "git rev-parse HEAD").read()?;
|
||||
let fetch_head = cmd!(sh, "git rev-parse FETCH_HEAD").read()?;
|
||||
if head != fetch_head {
|
||||
bail!(
|
||||
"Josh created a non-roundtrip push! Do NOT merge this into rustc!\n\
|
||||
Expected {head}, got {fetch_head}."
|
||||
);
|
||||
}
|
||||
println!(
|
||||
"Confirmed that the push round-trips back to rustc-dev-guide properly. Please create a rustc PR:"
|
||||
);
|
||||
println!(
|
||||
// Open PR with `subtree update` title to silence the `no-merges` triagebot check
|
||||
" https://github.com/{UPSTREAM_REPO}/compare/{github_user}:{branch}?quick_pull=1&title=rustc-dev-guide+subtree+update&body=r?+@ghost"
|
||||
);
|
||||
|
||||
drop(josh);
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn start_josh() -> anyhow::Result<impl Drop> {
|
||||
// Determine cache directory.
|
||||
let local_dir = {
|
||||
let user_dirs =
|
||||
directories::ProjectDirs::from("org", "rust-lang", "rustc-dev-guide-josh").unwrap();
|
||||
user_dirs.cache_dir().to_owned()
|
||||
};
|
||||
|
||||
// Start josh, silencing its output.
|
||||
let mut cmd = process::Command::new("josh-proxy");
|
||||
cmd.arg("--local").arg(local_dir);
|
||||
cmd.arg("--remote").arg("https://github.com");
|
||||
cmd.arg("--port").arg(JOSH_PORT.to_string());
|
||||
cmd.arg("--no-background");
|
||||
cmd.stdout(process::Stdio::null());
|
||||
cmd.stderr(process::Stdio::null());
|
||||
let josh = cmd.spawn().context("failed to start josh-proxy, make sure it is installed")?;
|
||||
|
||||
// Create a wrapper that stops it on drop.
|
||||
struct Josh(process::Child);
|
||||
impl Drop for Josh {
|
||||
fn drop(&mut self) {
|
||||
#[cfg(unix)]
|
||||
{
|
||||
// Try to gracefully shut it down.
|
||||
process::Command::new("kill")
|
||||
.args(["-s", "INT", &self.0.id().to_string()])
|
||||
.output()
|
||||
.expect("failed to SIGINT josh-proxy");
|
||||
// Sadly there is no "wait with timeout"... so we just give it some time to finish.
|
||||
std::thread::sleep(Duration::from_millis(100));
|
||||
// Now hopefully it is gone.
|
||||
if self.0.try_wait().expect("failed to wait for josh-proxy").is_some() {
|
||||
return;
|
||||
}
|
||||
}
|
||||
// If that didn't work (or we're not on Unix), kill it hard.
|
||||
eprintln!(
|
||||
"I have to kill josh-proxy the hard way, let's hope this does not break anything."
|
||||
);
|
||||
self.0.kill().expect("failed to SIGKILL josh-proxy");
|
||||
}
|
||||
}
|
||||
|
||||
// Wait until the port is open. We try every 10ms until 1s passed.
|
||||
for _ in 0..100 {
|
||||
// This will generally fail immediately when the port is still closed.
|
||||
let josh_ready = net::TcpStream::connect_timeout(
|
||||
&net::SocketAddr::from(([127, 0, 0, 1], JOSH_PORT)),
|
||||
Duration::from_millis(1),
|
||||
);
|
||||
if josh_ready.is_ok() {
|
||||
return Ok(Josh(josh));
|
||||
}
|
||||
// Not ready yet.
|
||||
std::thread::sleep(Duration::from_millis(10));
|
||||
}
|
||||
bail!("Even after waiting for 1s, josh-proxy is still not available.")
|
||||
}
|
||||
}
|
||||
|
|
@ -1 +1 @@
|
|||
c96a69059ecc618b519da385a6ccd03155aa0237
|
||||
fd2eb391d032181459773f3498c17b198513e0d0
|
||||
|
|
|
|||
|
|
@ -6,14 +6,14 @@ In the near future, `std::autodiff` should become available in nightly builds fo
|
|||
|
||||
First you need to clone and configure the Rust repository:
|
||||
```bash
|
||||
git clone --depth=1 git@github.com:rust-lang/rust.git
|
||||
git clone git@github.com:rust-lang/rust
|
||||
cd rust
|
||||
./configure --enable-llvm-link-shared --enable-llvm-plugins --enable-llvm-enzyme --release-channel=nightly --enable-llvm-assertions --enable-clang --enable-lld --enable-option-checking --enable-ninja --disable-docs
|
||||
```
|
||||
|
||||
Afterwards you can build rustc using:
|
||||
```bash
|
||||
./x.py build --stage 1 library
|
||||
./x build --stage 1 library
|
||||
```
|
||||
|
||||
Afterwards rustc toolchain link will allow you to use it through cargo:
|
||||
|
|
@ -25,10 +25,10 @@ rustup toolchain install nightly # enables -Z unstable-options
|
|||
You can then run our test cases:
|
||||
|
||||
```bash
|
||||
./x.py test --stage 1 tests/codegen/autodiff
|
||||
./x.py test --stage 1 tests/pretty/autodiff
|
||||
./x.py test --stage 1 tests/ui/autodiff
|
||||
./x.py test --stage 1 tests/ui/feature-gates/feature-gate-autodiff.rs
|
||||
./x test --stage 1 tests/codegen/autodiff
|
||||
./x test --stage 1 tests/pretty/autodiff
|
||||
./x test --stage 1 tests/ui/autodiff
|
||||
./x test --stage 1 tests/ui/feature-gates/feature-gate-autodiff.rs
|
||||
```
|
||||
|
||||
Autodiff is still experimental, so if you want to use it in your own projects, you will need to add `lto="fat"` to your Cargo.toml
|
||||
|
|
@ -45,7 +45,7 @@ apt install wget vim python3 git curl libssl-dev pkg-config lld ninja-build cmak
|
|||
```
|
||||
Then build rustc in a slightly altered way:
|
||||
```bash
|
||||
git clone --depth=1 https://github.com/rust-lang/rust.git
|
||||
git clone https://github.com/rust-lang/rust
|
||||
cd rust
|
||||
./configure --enable-llvm-link-shared --enable-llvm-plugins --enable-llvm-enzyme --release-channel=nightly --enable-llvm-assertions --enable-clang --enable-lld --enable-option-checking --enable-ninja --disable-docs
|
||||
./x dist
|
||||
|
|
@ -66,7 +66,7 @@ We recommend that approach, if you just want to use any of them and have no expe
|
|||
However, if you prefer to just build Enzyme without Rust, then these instructions might help.
|
||||
|
||||
```bash
|
||||
git clone --depth=1 git@github.com:llvm/llvm-project.git
|
||||
git clone git@github.com:llvm/llvm-project
|
||||
cd llvm-project
|
||||
mkdir build
|
||||
cd build
|
||||
|
|
@ -77,7 +77,7 @@ ninja install
|
|||
This gives you a working LLVM build, now we can continue with building Enzyme.
|
||||
Leave the `llvm-project` folder, and execute the following commands:
|
||||
```bash
|
||||
git clone git@github.com:EnzymeAD/Enzyme.git
|
||||
git clone git@github.com:EnzymeAD/Enzyme
|
||||
cd Enzyme/enzyme
|
||||
mkdir build
|
||||
cd build
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ There are three main ways we use dependencies:
|
|||
As a general rule:
|
||||
- Use crates.io for libraries that could be useful for others in the ecosystem
|
||||
- Use subtrees for tools that depend on compiler internals and need to be updated if there are breaking
|
||||
changes
|
||||
changes
|
||||
- Use submodules for tools that are independent of the compiler
|
||||
|
||||
## External Dependencies (subtrees)
|
||||
|
|
@ -23,6 +23,8 @@ The following external projects are managed using some form of a `subtree`:
|
|||
* [rust-analyzer](https://github.com/rust-lang/rust-analyzer)
|
||||
* [rustc_codegen_cranelift](https://github.com/rust-lang/rustc_codegen_cranelift)
|
||||
* [rustc-dev-guide](https://github.com/rust-lang/rustc-dev-guide)
|
||||
* [compiler-builtins](https://github.com/rust-lang/compiler-builtins)
|
||||
* [stdarch](https://github.com/rust-lang/stdarch)
|
||||
|
||||
In contrast to `submodule` dependencies
|
||||
(see below for those), the `subtree` dependencies are just regular files and directories which can
|
||||
|
|
@ -34,20 +36,61 @@ implement a new tool feature or test, that should happen in one collective rustc
|
|||
`subtree` dependencies are currently managed by two distinct approaches:
|
||||
|
||||
* Using `git subtree`
|
||||
* `clippy` ([sync guide](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/sync.html#performing-the-sync-from-rust-langrust-to-clippy))
|
||||
* `portable-simd` ([sync script](https://github.com/rust-lang/portable-simd/blob/master/subtree-sync.sh))
|
||||
* `rustfmt`
|
||||
* `rustc_codegen_cranelift` ([sync script](https://github.com/rust-lang/rustc_codegen_cranelift/blob/113af154d459e41b3dc2c5d7d878e3d3a8f33c69/scripts/rustup.sh#L7))
|
||||
* `clippy` ([sync guide](https://doc.rust-lang.org/nightly/clippy/development/infrastructure/sync.html#performing-the-sync-from-rust-langrust-to-clippy))
|
||||
* `portable-simd` ([sync script](https://github.com/rust-lang/portable-simd/blob/master/subtree-sync.sh))
|
||||
* `rustfmt`
|
||||
* `rustc_codegen_cranelift` ([sync script](https://github.com/rust-lang/rustc_codegen_cranelift/blob/113af154d459e41b3dc2c5d7d878e3d3a8f33c69/scripts/rustup.sh#L7))
|
||||
* Using the [josh] tool
|
||||
* `miri` ([sync guide](https://github.com/rust-lang/miri/blob/master/CONTRIBUTING.md#advanced-topic-syncing-with-the-rustc-repo))
|
||||
* `rust-analyzer` ([sync script](https://github.com/rust-lang/rust-analyzer/blob/2e13684be123eca7181aa48e043e185d8044a84a/xtask/src/release.rs#L147))
|
||||
* `rustc-dev-guide` ([sync guide](https://github.com/rust-lang/rustc-dev-guide#synchronizing-josh-subtree-with-rustc))
|
||||
* `miri` ([sync guide](https://github.com/rust-lang/miri/blob/master/CONTRIBUTING.md#advanced-topic-syncing-with-the-rustc-repo))
|
||||
* `rust-analyzer` ([sync script](https://github.com/rust-lang/rust-analyzer/blob/2e13684be123eca7181aa48e043e185d8044a84a/xtask/src/release.rs#L147))
|
||||
* `rustc-dev-guide` ([josh sync](#synchronizing-a-josh-subtree))
|
||||
* `compiler-builtins` ([josh sync](#synchronizing-a-josh-subtree))
|
||||
* `stdarch` ([josh sync](#synchronizing-a-josh-subtree))
|
||||
|
||||
The [josh] tool is an alternative to git subtrees, which manages git history in a different way and scales better to larger repositories. Specific tooling is required to work with josh, you can check out the `miri` or `rust-analyzer` scripts linked above for inspiration. If you want to migrate a repository dependency from `git subtree` or `git submodule` to josh, you can check out [this guide](https://hackmd.io/7pOuxnkdQDaL1Y1FQr65xg).
|
||||
### Josh subtrees
|
||||
|
||||
Below you can find a guide on how to perform push and pull synchronization with the main rustc repo using `git subtree`, although these instructions might differ repo from repo.
|
||||
The [josh] tool is an alternative to git subtrees, which manages git history in a different way and scales better to larger repositories. Specific tooling is required to work with josh; you can check out the `miri` or `rust-analyzer` scripts linked above for inspiration. We provide a helper [`rustc-josh-sync`][josh-sync] tool to help with the synchronization, described [below](#synchronizing-a-josh-subtree).
|
||||
|
||||
### Synchronizing a subtree
|
||||
### Synchronizing a Josh subtree
|
||||
|
||||
We use a dedicated tool called [`rustc-josh-sync`][josh-sync] for performing Josh subtree updates.
|
||||
Currently, we are migrating Josh repositories to it. So far, it is used in:
|
||||
|
||||
- compiler-builtins
|
||||
- rustc-dev-guide
|
||||
- stdarch
|
||||
|
||||
To install the tool:
|
||||
```
|
||||
cargo install --locked --git https://github.com/rust-lang/josh-sync
|
||||
```
|
||||
|
||||
Both pulls (synchronize changes from rust-lang/rust into the subtree) and pushes (synchronize
|
||||
changes from the subtree to rust-lang/rust) are performed from the subtree repository (so first
|
||||
switch to its repository checkout directory in your terminal).
|
||||
|
||||
#### Performing pull
|
||||
1) Checkout a new branch that will be used to create a PR into the subtree
|
||||
2) Run the pull command
|
||||
```
|
||||
rustc-josh-sync pull
|
||||
```
|
||||
3) Push the branch to your fork and create a PR into the subtree repository
|
||||
- If you have `gh` CLI installed, `rustc-josh-sync` can create the PR for you.
|
||||
|
||||
#### Performing push
|
||||
|
||||
1) Run the push command to create a branch named `<branch-name>` in a `rustc` fork under the `<gh-username>` account
|
||||
```
|
||||
rustc-josh-sync push <branch-name> <gh-username>
|
||||
```
|
||||
2) Create a PR from `<branch-name>` into `rust-lang/rust`
|
||||
|
||||
### Creating a new Josh subtree dependency
|
||||
|
||||
If you want to migrate a repository dependency from `git subtree` or `git submodule` to josh, you can check out [this guide](https://hackmd.io/7pOuxnkdQDaL1Y1FQr65xg).
|
||||
|
||||
### Synchronizing a git subtree
|
||||
|
||||
Periodically the changes made to subtree based dependencies need to be synchronized between this
|
||||
repository and the upstream tool repositories.
|
||||
|
|
@ -129,3 +172,4 @@ the week leading up to the beta cut.
|
|||
[toolstate website]: https://rust-lang-nursery.github.io/rust-toolstate/
|
||||
[Toolstate chapter]: https://forge.rust-lang.org/infra/toolstate.html
|
||||
[josh]: https://josh-project.github.io/josh/intro.html
|
||||
[josh-sync]: https://github.com/rust-lang/josh-sync
|
||||
|
|
|
|||
|
|
@ -6,14 +6,14 @@ In the future, `std::offload` should become available in nightly builds for user
|
|||
|
||||
First you need to clone and configure the Rust repository:
|
||||
```bash
|
||||
git clone --depth=1 git@github.com:rust-lang/rust.git
|
||||
git clone git@github.com:rust-lang/rust
|
||||
cd rust
|
||||
./configure --enable-llvm-link-shared --release-channel=nightly --enable-llvm-assertions --enable-offload --enable-enzyme --enable-clang --enable-lld --enable-option-checking --enable-ninja --disable-docs
|
||||
```
|
||||
|
||||
Afterwards you can build rustc using:
|
||||
```bash
|
||||
./x.py build --stage 1 library
|
||||
./x build --stage 1 library
|
||||
```
|
||||
|
||||
Afterwards rustc toolchain link will allow you to use it through cargo:
|
||||
|
|
@ -26,7 +26,7 @@ rustup toolchain install nightly # enables -Z unstable-options
|
|||
|
||||
## Build instruction for LLVM itself
|
||||
```bash
|
||||
git clone --depth=1 git@github.com:llvm/llvm-project.git
|
||||
git clone git@github.com:llvm/llvm-project
|
||||
cd llvm-project
|
||||
mkdir build
|
||||
cd build
|
||||
|
|
@ -40,7 +40,7 @@ This gives you a working LLVM build.
|
|||
## Testing
|
||||
run
|
||||
```
|
||||
./x.py test --stage 1 tests/codegen/gpu_offload
|
||||
./x test --stage 1 tests/codegen/gpu_offload
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
|
|
|||
|
|
@ -4,17 +4,15 @@ FIXME: This file talks about invariants of the type system as a whole, not only
|
|||
|
||||
There are a lot of invariants - things the type system guarantees to be true at all times -
|
||||
which are desirable or expected from other languages and type systems. Unfortunately, quite
|
||||
a few of them do not hold in Rust right now. This is either a fundamental to its design or
|
||||
caused by bugs and something that may change in the future.
|
||||
a few of them do not hold in Rust right now. This is either fundamental to its design or
|
||||
caused by bugs, and something that may change in the future.
|
||||
|
||||
It is important to know about the things you can assume while working on - and with - the
|
||||
It is important to know about the things you can assume while working on, and with, the
|
||||
type system, so here's an incomplete and unofficial list of invariants of
|
||||
the core type system:
|
||||
|
||||
- ✅: this invariant mostly holds, with some weird exceptions, you can rely on it outside
|
||||
of these cases
|
||||
- ❌: this invariant does not hold, either due to bugs or by design, you must not rely on
|
||||
it for soundness or have to be incredibly careful when doing so
|
||||
- ✅: this invariant mostly holds, with some weird exceptions or current bugs
|
||||
- ❌: this invariant does not hold, and is unlikely to do so in the future; do not rely on it for soundness or have to be incredibly careful when doing so
|
||||
|
||||
### `wf(X)` implies `wf(normalize(X))` ✅
|
||||
|
||||
|
|
@ -23,20 +21,23 @@ well-formed after normalizing said aliases. We rely on this as
|
|||
otherwise we would have to re-check for well-formedness for these
|
||||
types.
|
||||
|
||||
This currently does not hold due to a type system unsoundness: [#84533](https://github.com/rust-lang/rust/issues/84533).
|
||||
|
||||
### Structural equality modulo regions implies semantic equality ✅
|
||||
|
||||
If you have a some type and equate it to itself after replacing any regions with unique
|
||||
inference variables in both the lhs and rhs, the now potentially structurally different
|
||||
types should still be equal to each other.
|
||||
|
||||
Needed to prevent goals from succeeding in HIR typeck and then failing in MIR borrowck.
|
||||
If this invariant is broken MIR typeck ends up failing with an ICE.
|
||||
This is needed to prevent goals from succeeding in HIR typeck and then failing in MIR borrowck.
|
||||
If this invariant is broken, MIR typeck ends up failing with an ICE.
|
||||
|
||||
### Applying inference results from a goal does not change its result ❌
|
||||
|
||||
TODO: this invariant is formulated in a weird way and needs to be elaborated.
|
||||
Pretty much: I would like this check to only fail if there's a solver bug:
|
||||
https://github.com/rust-lang/rust/blob/2ffeb4636b4ae376f716dc4378a7efb37632dc2d/compiler/rustc_trait_selection/src/solve/eval_ctxt.rs#L391-L407
|
||||
<https://github.com/rust-lang/rust/blob/2ffeb4636b4ae376f716dc4378a7efb37632dc2d/compiler/rustc_trait_selection/src/solve/eval_ctxt.rs#L391-L407>.
|
||||
We should readd this check and see where it breaks :3
|
||||
|
||||
If we prove some goal/equate types/whatever, apply the resulting inference constraints,
|
||||
and then redo the original action, the result should be the same.
|
||||
|
|
@ -73,34 +74,10 @@ Many of the currently known unsound issues end up relying on this invariant bein
|
|||
It is however very difficult to imagine a sound type system without this invariant, so
|
||||
the issue is that the invariant is broken, not that we incorrectly rely on it.
|
||||
|
||||
### Generic goals and their instantiations have the same result ✅
|
||||
|
||||
Pretty much: If we successfully typecheck a generic function concrete instantiations
|
||||
of that function should also typeck. We should not get errors post-monomorphization.
|
||||
We can however get overflow errors at that point.
|
||||
|
||||
TODO: example for overflow error post-monomorphization
|
||||
|
||||
This invariant is relied on to allow the normalization of generic aliases. Breaking
|
||||
it can easily result in unsoundness, e.g. [#57893](https://github.com/rust-lang/rust/issues/57893)
|
||||
|
||||
### Trait goals in empty environments are proven by a unique impl ✅
|
||||
|
||||
If a trait goal holds with an empty environment, there should be a unique `impl`,
|
||||
either user-defined or builtin, which is used to prove that goal. This is
|
||||
necessary to select a unique method.
|
||||
|
||||
We do however break this invariant in few cases, some of which are due to bugs,
|
||||
some by design:
|
||||
- *marker traits* are allowed to overlap as they do not have associated items
|
||||
- *specialization* allows specializing impls to overlap with their parent
|
||||
- the builtin trait object trait implementation can overlap with a user-defined impl:
|
||||
[#57893]
|
||||
|
||||
### The type system is complete ❌
|
||||
|
||||
The type system is not complete, it often adds unnecessary inference constraints, and errors
|
||||
even though the goal could hold.
|
||||
The type system is not complete.
|
||||
It often adds unnecessary inference constraints, and errors even though the goal could hold.
|
||||
|
||||
- method selection
|
||||
- opaque type inference
|
||||
|
|
@ -108,47 +85,88 @@ even though the goal could hold.
|
|||
- preferring `ParamEnv` candidates over `Impl` candidates during candidate selection
|
||||
in the trait solver
|
||||
|
||||
### Goals keep their result from HIR typeck afterwards ✅
|
||||
|
||||
Having a goal which succeeds during HIR typeck but fails when being reevaluated during MIR borrowck causes ICE, e.g. [#140211](https://github.com/rust-lang/rust/issues/140211).
|
||||
|
||||
Having a goal which succeeds during HIR typeck but fails after being instantiated is unsound, e.g. [#140212](https://github.com/rust-lang/rust/issues/140212).
|
||||
|
||||
It is interesting that we allow some incompleteness in the trait solver while still maintaining this limitation. It would be nice if there was a clear way to separate the "allowed incompleteness" from behavior which would break this invariant.
|
||||
|
||||
#### Normalization must not change results
|
||||
|
||||
This invariant is relied on to allow the normalization of generic aliases. Breaking
|
||||
it can easily result in unsoundness, e.g. [#57893](https://github.com/rust-lang/rust/issues/57893).
|
||||
|
||||
#### Goals may still overflow after instantiation
|
||||
|
||||
This happens they start to hit the recursion limit.
|
||||
We also have diverging aliases which are scuffed.
|
||||
It's unclear how these should be handled :3
|
||||
|
||||
### Trait goals in empty environments are proven by a unique impl ✅
|
||||
|
||||
If a trait goal holds with an empty environment, there should be a unique `impl`,
|
||||
either user-defined or builtin, which is used to prove that goal. This is
|
||||
necessary to select unique methods and associated items.
|
||||
|
||||
We do however break this invariant in a few cases, some of which are due to bugs, some by design:
|
||||
- *marker traits* are allowed to overlap as they do not have associated items
|
||||
- *specialization* allows specializing impls to overlap with their parent
|
||||
- the builtin trait object trait implementation can overlap with a user-defined impl:
|
||||
[#57893](https://github.com/rust-lang/rust/issues/57893)
|
||||
|
||||
|
||||
#### The type system is complete during the implicit negative overlap check in coherence ✅
|
||||
|
||||
For more on overlap checking: [coherence]
|
||||
For more on overlap checking, see [Coherence chapter].
|
||||
|
||||
During the implicit negative overlap check in coherence we must never return *error* for
|
||||
goals which can be proven. This would allow for overlapping impls with potentially different
|
||||
associated items, breaking a bunch of other invariants.
|
||||
During the implicit negative overlap check in coherence,
|
||||
we must never return *error* for goals which can be proven.
|
||||
This would allow for overlapping impls with potentially different associated items,
|
||||
breaking a bunch of other invariants.
|
||||
|
||||
This invariant is currently broken in many different ways while actually something we rely on.
|
||||
We have to be careful as it is quite easy to break:
|
||||
- generalization of aliases
|
||||
- generalization during subtyping binders (luckily not exploitable in coherence)
|
||||
|
||||
### Trait solving must be (free) lifetime agnostic ✅
|
||||
### Trait solving must not depend on lifetimes being different ✅
|
||||
|
||||
Trait solving during codegen should have the same result as during typeck. As we erase
|
||||
all free regions during codegen we must not rely on them during typeck. A noteworthy example
|
||||
is special behavior for `'static`.
|
||||
If a goal holds with lifetimes being different, it must also hold with these lifetimes being the same. We otherwise get post-monomorphization errors during codegen or unsoundness due to invalid vtables.
|
||||
|
||||
We could also just get inconsistent behavior when first proving a goal with different lifetimes which are later constrained to be equal.
|
||||
|
||||
### Trait solving in bodies must not depend on lifetimes being equal ✅
|
||||
|
||||
We also have to be careful with relying on equality of regions in the trait solver.
|
||||
This is fine for codegen, as we treat all erased regions as equal. We can however
|
||||
lose equality information from HIR to MIR typeck.
|
||||
|
||||
The new solver "uniquifies regions" during canonicalization, canonicalizing `u32: Trait<'x, 'x>`
|
||||
as `exists<'0, '1> u32: Trait<'0, '1>`, to make it harder to rely on this property.
|
||||
This currently does not hold with the new solver: [trait-system-refactor-initiative#27](https://github.com/rust-lang/trait-system-refactor-initiative/issues/27).
|
||||
|
||||
### Removing ambiguity makes strictly more things compile ❌
|
||||
|
||||
Ideally we *should* not rely on ambiguity for things to compile.
|
||||
Not doing that will cause future improvements to be breaking changes.
|
||||
|
||||
Due to *incompleteness* this is not the case and improving inference can result in inference
|
||||
changes, breaking existing projects.
|
||||
Due to *incompleteness* this is not the case,
|
||||
and improving inference can result in inference changes, breaking existing projects.
|
||||
|
||||
### Semantic equality implies structural equality ✅
|
||||
|
||||
Two types being equal in the type system must mean that they have the
|
||||
same `TypeId` after instantiating their generic parameters with concrete
|
||||
arguments. This currently does not hold: [#97156].
|
||||
arguments. We can otherwise use their different `TypeId`s to impact trait selection.
|
||||
|
||||
[#57893]: https://github.com/rust-lang/rust/issues/57893
|
||||
[#97156]: https://github.com/rust-lang/rust/issues/97156
|
||||
[#114936]: https://github.com/rust-lang/rust/issues/114936
|
||||
[coherence]: ../coherence.md
|
||||
We lookup types using structural equality during codegen, but this shouldn't necessarily be unsound
|
||||
- may result in redundant method codegen or backend type check errors?
|
||||
- we also rely on it in CTFE assertions
|
||||
|
||||
### Semantically different types have different `TypeId`s ✅
|
||||
|
||||
Semantically different `'static` types need different `TypeId`s to avoid transmutes,
|
||||
for example `for<'a> fn(&'a str)` vs `fn(&'static str)` must have a different `TypeId`.
|
||||
|
||||
|
||||
[coherence chapter]: ../coherence.md
|
||||
|
|
|
|||
|
|
@ -59,7 +59,7 @@ not be exhaustive. Directives can generally be found by browsing the
|
|||
| `aux-crate` | Like `aux-build` but makes available as extern prelude | All except `run-make` | `<extern_prelude_name>=<path/to/aux/file.rs>` |
|
||||
| `aux-codegen-backend` | Similar to `aux-build` but pass the compiled dylib to `-Zcodegen-backend` when building the main file | `ui-fulldeps` | Path to codegen backend file |
|
||||
| `proc-macro` | Similar to `aux-build`, but for aux forces host and don't use `-Cprefer-dynamic`[^pm]. | All except `run-make` | Path to auxiliary proc-macro `.rs` file |
|
||||
| `build-aux-docs` | Build docs for auxiliaries as well | All except `run-make` | N/A |
|
||||
| `build-aux-docs` | Build docs for auxiliaries as well. Note that this only works with `aux-build`, not `aux-crate`. | All except `run-make` | N/A |
|
||||
|
||||
[^pm]: please see the Auxiliary proc-macro section in the
|
||||
[compiletest](./compiletest.md) chapter for specifics.
|
||||
|
|
|
|||
|
|
@ -111,12 +111,14 @@ and it can be invoked so:
|
|||
|
||||
This requires building all of the documentation, which might take a while.
|
||||
|
||||
### Dist check
|
||||
### `distcheck`
|
||||
|
||||
`distcheck` verifies that the source distribution tarball created by the build
|
||||
system will unpack, build, and run all tests.
|
||||
|
||||
> Example: `./x test distcheck`
|
||||
```console
|
||||
./x test distcheck
|
||||
```
|
||||
|
||||
### Tool tests
|
||||
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ for testing:
|
|||
|
||||
- `RUSTC_BOOTSTRAP=1` will "cheat" and bypass usual stability checking, allowing
|
||||
you to use unstable features and cli flags on a stable `rustc`.
|
||||
- `RUSTC_BOOTSTRAP=-1` will force a given `rustc` to pretend that is a stable
|
||||
- `RUSTC_BOOTSTRAP=-1` will force a given `rustc` to pretend it is a stable
|
||||
compiler, even if it's actually a nightly `rustc`. This is useful because some
|
||||
behaviors of the compiler (e.g. diagnostics) can differ depending on whether
|
||||
the compiler is nightly or not.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue