Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Tracking Issue for changing rustc target docs #120745

Open
3 of 9 tasks
Noratrieb opened this issue Feb 7, 2024 · 0 comments
Open
3 of 9 tasks

Tracking Issue for changing rustc target docs #120745

Noratrieb opened this issue Feb 7, 2024 · 0 comments
Assignees
@Noratrieb
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-targets Area: Concerning the implications of different compiler targets C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@Noratrieb
Copy link
Member

Noratrieb commented Feb 7, 2024 •
edited
Loading

This is the tracking issue for changing rustc target docs to be generated based on the existing target triple patterns, ensuring that there's a doc page for every single target.

Discussion in https://rust-lang.zulipchat.com/#narrow/stream/131828-t-compiler/topic/generating.20target.20documentation with a draft implementation in https://github.com/Nilstrieb/target-tier-docs-experiment.

Steps

Future possibilities

  • Keep tier, host_tools and std in sync with reality
@Noratrieb Noratrieb added C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-targets Area: Concerning the implications of different compiler targets labels Feb 7, 2024
@Noratrieb Noratrieb self-assigned this Feb 7, 2024
@Noratrieb Noratrieb mentioned this issue Feb 13, 2024
Open
@Noratrieb Noratrieb mentioned this issue Mar 17, 2024
Merged
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Mar 24, 2024
@workingjubilee
Rollup merge of rust-lang#121051 - Nilstrieb:targetting, r=davidtwco,…
10d8ab5 
…onur-ozkan

Introduce infrastructure for generating target docs

See rust-lang#120745

It's highly unlikely that the format is optimal, but it's okay at least and can always be improved. Mostly posting this to get something working so we can continue.

Use `TARGET_CHECK_ONLY=0` to actually build the book instead of just checking the new docs.

r? `@davidtwco`
matthiaskrgr added a commit to matthiaskrgr/rust that referenced this issue Mar 24, 2024
@matthiaskrgr
Rollup merge of rust-lang#121051 - Nilstrieb:targetting, r=davidtwco,…
731e337 
…onur-ozkan

Introduce infrastructure for generating target docs

See rust-lang#120745

It's highly unlikely that the format is optimal, but it's okay at least and can always be improved. Mostly posting this to get something working so we can continue.

Use `TARGET_CHECK_ONLY=0` to actually build the book instead of just checking the new docs.

r? ``@davidtwco``
This was referenced Apr 20, 2024
Merged
Closed
@harmou01 harmou01 mentioned this issue Jul 3, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this issue Jul 15, 2024
@bors
Auto merge of rust-lang#127265 - harmou01:dev/harmou01/target-spec-me…
cde8c48 
…tadata, r=Nilstrieb

Fill out target-spec metadata for all targets

**What does this PR try to resolve?**

This PR completes the target-spec metadata fields for all targets. This is required for a corresponding Cargo PR which adds a check for whether a target supports building the standard library when the `-Zbuild-std=std` flag is passed ([see this issue](rust-lang/wg-cargo-std-aware#87). This functionality in Cargo is reliant on the output of `--print=target-spec-json`.

**How should we test and review this PR?**

Check that a given target-spec metadata has been updated with:
```
$ ./x.py build library/std
$ build/host/stage1/bin/rustc --print=target-spec-json --target <target_name> -Zunstable-options
```

**Additional Information**

A few things to note:
* Where a targets 'std' or 'host tools' support is listed as '?' in the rust docs, these are left as 'None' with this PR. The corresponding changes in cargo will only reject an attempt to build std if the 'std' field is 'Some(false)'. In the case it is 'None', cargo will continue trying to build
* There's no rush for this to be merged. I understand that the format for this is not finalised yet.
* Related: rust-lang#120745
workingjubilee added a commit to workingjubilee/rustc that referenced this issue Jul 15, 2024
@workingjubilee
Rollup merge of rust-lang#127265 - harmou01:dev/harmou01/target-spec-…
8f91841 
…metadata, r=Nilstrieb

Fill out target-spec metadata for all targets

**What does this PR try to resolve?**

This PR completes the target-spec metadata fields for all targets. This is required for a corresponding Cargo PR which adds a check for whether a target supports building the standard library when the `-Zbuild-std=std` flag is passed ([see this issue](rust-lang/wg-cargo-std-aware#87). This functionality in Cargo is reliant on the output of `--print=target-spec-json`.

**How should we test and review this PR?**

Check that a given target-spec metadata has been updated with:
```
$ ./x.py build library/std
$ build/host/stage1/bin/rustc --print=target-spec-json --target <target_name> -Zunstable-options
```

**Additional Information**

A few things to note:
* Where a targets 'std' or 'host tools' support is listed as '?' in the rust docs, these are left as 'None' with this PR. The corresponding changes in cargo will only reject an attempt to build std if the 'std' field is 'Some(false)'. In the case it is 'None', cargo will continue trying to build
* There's no rush for this to be merged. I understand that the format for this is not finalised yet.
* Related: rust-lang#120745
bors added a commit to rust-lang-ci/rust that referenced this issue Jul 15, 2024
@bors
Auto merge of rust-lang#127265 - harmou01:dev/harmou01/target-spec-me…
adeb79d 
…tadata, r=Nilstrieb

Fill out target-spec metadata for all targets

**What does this PR try to resolve?**

This PR completes the target-spec metadata fields for all targets. This is required for a corresponding Cargo PR which adds a check for whether a target supports building the standard library when the `-Zbuild-std=std` flag is passed ([see this issue](rust-lang/wg-cargo-std-aware#87). This functionality in Cargo is reliant on the output of `--print=target-spec-json`.

**How should we test and review this PR?**

Check that a given target-spec metadata has been updated with:
```
$ ./x.py build library/std
$ build/host/stage1/bin/rustc --print=target-spec-json --target <target_name> -Zunstable-options
```

**Additional Information**

A few things to note:
* Where a targets 'std' or 'host tools' support is listed as '?' in the rust docs, these are left as 'None' with this PR. The corresponding changes in cargo will only reject an attempt to build std if the 'std' field is 'Some(false)'. In the case it is 'None', cargo will continue trying to build
* There's no rush for this to be merged. I understand that the format for this is not finalised yet.
* Related: rust-lang#120745
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Noratrieb Noratrieb

Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-targets Area: Concerning the implications of different compiler targets C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Noratrieb