Refactor documentation for Apple targets #124772
Merged
Conversation
This file contains 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
- Fixed std support in top-level docs. - Added `*-apple-darwin` docs. - Added `i686-apple-darwin` docs. - Moved `aarch64-apple-ios-sim` to `*-apple-ios` and document all the iOS targets there. - Added `*-apple-ios-macabi` docs. - Add myself (madsmtm) as co-maintainer of most of these targets.
rustbot
added
S-waiting-on-review
|
These commits modify compiler targets. Some changes occurred in src/doc/rustc/src/platform-support cc @Nilstrieb |
rustbot
added
the
O-apple
This was referenced May 5, 2024
|
works for me. The targets are similar enough and I use them that I can try to help if things break. |
simlay
approved these changes
May 6, 2024
|
r? compiler |
|
I don't have an opinion on the changes, but they look like an improvement and y'all seem happy with it. @bors r+ rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 21, 2024
…iaskrgr Rollup of 7 pull requests Successful merges: - rust-lang#124570 (Miscellaneous cleanups) - rust-lang#124772 (Refactor documentation for Apple targets) - rust-lang#125011 (Add opt-for-size core lib feature flag) - rust-lang#125218 (Migrate `run-make/no-intermediate-extras` to new `rmake.rs`) - rust-lang#125225 (Use functions from `crt_externs.h` on iOS/tvOS/watchOS/visionOS) - rust-lang#125266 (compiler: add simd_ctpop intrinsic) - rust-lang#125348 (Small fixes to `std::path::absolute` docs) Failed merges: - rust-lang#125296 (Fix `unexpected_cfgs` lint on std) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 21, 2024
Rollup merge of rust-lang#124772 - madsmtm:apple-platform-support-docs, r=oli-obk Refactor documentation for Apple targets Refactor the documentation for Apple targets in `rustc`'s platform support page to make it clear what the supported OS version is and which environment variables are being read (`*_DEPLOYMENT_TARGET` and `SDKROOT`). This fixes rust-lang#124215. Note that I've expanded the `aarch64-apple-ios-sim` maintainers `@badboy` and `@deg4uss3r` to include being maintainer of all `*-apple-ios-*` targets. If you do not wish to be so, please state that, then I'll explicitly note that in the docs. Additionally, I've added myself as co-maintainer of most of these targets. r? `@thomcc` I think the documentation you've previously written on tvOS is great, have mostly modified it to have a more consistent formatting with the rest of the Apple target. I recognize that there's quite a few changes here, feel free to ask about any of them! --- CC `@simlay` `@Nilstrieb` `@rustbot` label O-apple
weihanglo
reviewed
May 22, 2024
Comment on lines
+23
to
+26
| - [arm64e-apple-darwin.md](platform-support/arm64e-apple-darwin.md) | ||
| - [\*-apple-ios](platform-support/apple-ios.md) | ||
| - [\*-apple-ios-macabi](platform-support/apple-ios-macabi.md) | ||
| - [arm64e-apple-ios.md](platform-support/arm64e-apple-ios.md) |
There was a problem hiding this comment.
the .md suffix is probably not needed?
Suggested change
| - [arm64e-apple-darwin.md](platform-support/arm64e-apple-darwin.md) | |
| - [\*-apple-ios](platform-support/apple-ios.md) | |
| - [\*-apple-ios-macabi](platform-support/apple-ios-macabi.md) | |
| - [arm64e-apple-ios.md](platform-support/arm64e-apple-ios.md) | |
| - [arm64e-apple-darwin](platform-support/arm64e-apple-darwin.md) | |
| - [\*-apple-ios](platform-support/apple-ios.md) | |
| - [\*-apple-ios-macabi](platform-support/apple-ios-macabi.md) | |
| - [arm64e-apple-ios](platform-support/arm64e-apple-ios.md) |
fmease
added a commit
to fmease/rust
that referenced
this pull request
May 22, 2024
Remove unnecessary `.md` from the documentation sidebar Oversight from rust-lang#124772, caught in rust-lang#124772 (comment). r? weihanglo
fmease
added a commit
to fmease/rust
that referenced
this pull request
May 22, 2024
Remove unnecessary `.md` from the documentation sidebar Oversight from rust-lang#124772, caught in rust-lang#124772 (comment). r? weihanglo
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 22, 2024
Rollup merge of rust-lang#125395 - madsmtm:fix-doc-summary, r=lqd Remove unnecessary `.md` from the documentation sidebar Oversight from rust-lang#124772, caught in rust-lang#124772 (comment). r? weihanglo
github-actions bot
pushed a commit
to rust-lang/miri
that referenced
this pull request
May 23, 2024
Remove unnecessary `.md` from the documentation sidebar Oversight from rust-lang/rust#124772, caught in rust-lang/rust#124772 (comment). r? weihanglo
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.
Refactor the documentation for Apple targets in
rustc's platform support page to make it clear what the supported OS version is and which environment variables are being read (*_DEPLOYMENT_TARGETandSDKROOT). This fixes #124215.Note that I've expanded the
aarch64-apple-ios-simmaintainers @badboy and @deg4uss3r to include being maintainer of all*-apple-ios-*targets. If you do not wish to be so, please state that, then I'll explicitly note that in the docs.Additionally, I've added myself as co-maintainer of most of these targets.
r? @thomcc
I think the documentation you've previously written on tvOS is great, have mostly modified it to have a more consistent formatting with the rest of the Apple target.
I recognize that there's quite a few changes here, feel free to ask about any of them!
CC @simlay @Nilstrieb
@rustbot label O-apple