-
-
Notifications
You must be signed in to change notification settings - Fork 1.1k
docs(dev-guide): mention how to support new compilation targets #4995
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+58
−1
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,10 @@ | ||
| # Summary | ||
|
|
||
| - [Introduction](index.md) | ||
| - [Linting](linting.md) | ||
| - [Linting](linting.md) | ||
| - [Coding standards](coding-standards.md) | ||
| - [Version numbers](version-numbers.md) | ||
| - [Recipes](recipes.md) | ||
| - [Release process](release-process.md) | ||
| - [Tips and tricks](tips-and-tricks.md) | ||
| - [Tracing](tracing.md) |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| # Recipes | ||
|
|
||
| This section contains some recipes for common tasks that you may want to | ||
| perform when contributing to rustup. | ||
|
|
||
| ## Supporting a new tier 2 target with host tools | ||
|
|
||
| In principle, all target tuples **with host tools** should be recognized by | ||
| rustup and have its official rustup builds. Thus, once a new target has been | ||
| promoted to tier 2 with host tools, it should also be explicitly supported by | ||
| rustup through the following steps: | ||
|
|
||
| 1. Informing rustup of the new target: | ||
|
|
||
| At the moment of writing, GitHub Actions' runners natively support Linux, | ||
| Windows, and macOS. Tier 2 builds are mostly cross-compiled from Linux | ||
| (except for Windows and macOS targets, which are directly compiled from the | ||
| target platform), and thus we will be focusing on the Linux case below. | ||
|
|
||
| You can refer to [rustup#4688] for a practical example for adding a new tier | ||
| 2 target via cross-builds from Linux, where you can find nearly all places | ||
| where you would need to mention your new target in the rustup codebase. | ||
|
|
||
| Notably, you would need to add a line in | ||
| `ci/actions-templates/linux-builds-template.yaml` to include it in rustup's | ||
| CI, while disabling the build for this target in all scenarios. At the | ||
| moment of writing, this is done by appending the YAML comment | ||
| `# skip-pr skip-master skip-stable` | ||
| at the end of the line when mentioning your target in that file. | ||
|
|
||
| On the other hand, if you need to support new Windows or macOS targets, | ||
| please don't hesitate to discuss this with the team in a dedicated [rustup | ||
| issue]. | ||
|
|
||
| [rustup#4688]: https://github.com/rust-lang/rustup/pull/4688 | ||
| [rustup issue]: https://github.com/rust-lang/rustup/issues | ||
|
|
||
| 2. Stabilizing the target: | ||
|
|
||
| When your new target reaches stable Rust, you can then enable the target in | ||
| certain CI scenarios, depending on the popularity of the target. At the | ||
| moment of writing, this is done by removing certain occurrences of `skip-*` | ||
| in the aforementioned YAML comment. In most cases, you would only need to | ||
| enable the target for the `stable` CI scenario by removing `skip-stable`. | ||
|
|
||
| You can refer to [rustup#4816] for a practical example for this step. | ||
|
|
||
| Do note that when creating the PR for this step, you will need to prove that | ||
| the target's CI is indeed working by removing `skip-pr` in a separate commit | ||
| to temporarily enable this target in this PR's CI. Once the CI is green, you | ||
| can send the link ([example][send-link]) to that CI run in the PR thread for | ||
| verification. After that, you can safely drop the temporary commit to get | ||
| the PR ready for merging. | ||
|
|
||
| [rustup#4816]: https://github.com/rust-lang/rustup/pull/4816 | ||
| [send-link]: https://github.com/rust-lang/rustup/pull/4816#issuecomment-4263419604 | ||
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.