Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion doc/dev-guide/src/SUMMARY.md
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)
48 changes: 48 additions & 0 deletions doc/dev-guide/src/recipes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Recipes

This section contains some recipes for common tasks that you may want to
perform when contributing to rustup.

## Supporting a new compilation target

Adding support for a new compilation target is actually easy:

1. Informing rustup about the new target:

Since you are here, it is quite likely that you are also promoting a target
from tier 3 to tier 2. As such, it is often sufficient to just cross-compile
rustup from Linux to that target.

You can refer to [rustup#4688] for a practical example for this step. You
can find in that PR a list of common places where you would need to add the
references of your new target in the rustup codebase.

Notably, you would need to add a line in
`ci/actions-templates/linux-builds-template.yaml` to enable it in rustup's
CI, with one caveat: if this target is not yet available in stable Rust, you
will need to disable its builds in the CI entirely. 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.

[rustup#4688]: https://github.com/rust-lang/rustup/pull/4688

2. Stabilizing the target:

When your new target reaches stable Rust, you can then enable the target in
CI. At the moment of writing, this is done by removing one or multiple
occurrences of `skip-*` in the aforementioned YAML comment. In most cases,
you would only need to enable the release CI for this target by removing
`skip-stable`.

You can refer to [rustup#4816] for a practical example for this step.

Do note that when creating the PR, to prove that the target CI is indeed

@rami3l rami3l Aug 3, 2026

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

working, you will need to temporarily enable this target in this PR's CI by
removing `skip-pr` in a separate commit. Once the CI is green, you can send
the link ([example][send-link]) to that CI run in the PR thread for
verification. Finally, 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
Loading