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

platform docs: clarify hexagon-unknown-none-elf example, add hexagon-unknown-linux-musl #121412

Merged
merged 2 commits into from
Feb 29, 2024
Merged

platform docs: clarify hexagon-unknown-none-elf example, add hexagon-unknown-linux-musl #121412

merged 2 commits into from
Feb 29, 2024

Conversation

androm3da
Copy link
Contributor

No description provided.

@rustbot
Copy link
Collaborator

rustbot commented Feb 21, 2024

r? @JohnTitor

rustbot has assigned @JohnTitor.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

@rustbot rustbot added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Feb 21, 2024
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@androm3da
Copy link
Contributor Author

@rustbot label -S-waiting-on-review +S-waiting-on-author

@rustbot rustbot added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 22, 2024
@androm3da androm3da force-pushed the bcain/update_hex_docs_03 branch 2 times, most recently from f2b6e63 to 611adbe Compare February 23, 2024 17:39
@androm3da
Copy link
Contributor Author

@rustbot label -S-waiting-on-author +S-waiting-on-review

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Feb 23, 2024
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@androm3da
Copy link
Contributor Author

I think the reference to platform-support/hexagon-unknown-linux-musl.md from platform-support.md is the problem, but I'm not quite sure of the right way to fix it. Maybe I omit the link from src/doc/rustc/src/platform-support.md for now and add it later? Could something be periodically indexing these docs/links and that's why I can't make this reference here?

  rustc/platform-support.html:439: broken link - `rustc/platform-support/hexagon-unknown-linux-musl.html`
  rustc/print.html:8634: broken link - `rustc/platform-support/hexagon-unknown-linux-musl.html`
  checked links in: 23.2s
  number of HTML files scanned: 35117
  number of HTML redirects found: 10578
  number of links checked: 3088381
  number of links ignored due to external: 71120
  number of links ignored due to exceptions: 19
  number of intra doc links ignored: 7
  errors found: 2
  found some broken links
  Build completed unsuccessfully in 0:32:18
    local time: Sat Feb 24 04:23:37 UTC 2024
    network time: Sat, 24 Feb 2024 04:23:37 GMT
  Error: Process completed with exit code 1.

@androm3da
Copy link
Contributor Author

I think the reference to platform-support/hexagon-unknown-linux-musl.md from platform-support.md is the problem, but I'm not quite sure of the right way to fix it. Maybe I omit the link from src/doc/rustc/src/platform-support.md for now and add it later? Could something be periodically indexing these docs/links and that's why I can't make this reference here?

  rustc/platform-support.html:439: broken link - `rustc/platform-support/hexagon-unknown-linux-musl.html`
  rustc/print.html:8634: broken link - `rustc/platform-support/hexagon-unknown-linux-musl.html`
  checked links in: 23.2s
  number of HTML files scanned: 35117
  number of HTML redirects found: 10578
  number of links checked: 3088381
  number of links ignored due to external: 71120
  number of links ignored due to exceptions: 19
  number of intra doc links ignored: 7
  errors found: 2
  found some broken links
  Build completed unsuccessfully in 0:32:18
    local time: Sat Feb 24 04:23:37 UTC 2024
    network time: Sat, 24 Feb 2024 04:23:37 GMT
  Error: Process completed with exit code 1.

@JohnTitor or @Amanieu do you happen to know if this error is expected? Should I just omit the link from platform-support.md or is there something else wrong w/this PR?

@Amanieu
Copy link
Member

Amanieu commented Feb 27, 2024

Perhaps you need to add a link to the page in SUMMARY.md?

@rust-log-analyzer

This comment has been minimized.

Sign in to view
@androm3da
Copy link
Contributor Author

Perhaps you need to add a link to the page in SUMMARY.md?

Thanks @Amanieu that seemed to do it. Did you just happen to know that was something that's usually done or did you figure out the error from the CI output? I'd like to better understand how I should find issues like these.

@Amanieu
Copy link
Member

Amanieu commented Feb 28, 2024

I guessed it by searching for other places that referred to platform-support/hexagon-unknown-none-elf.md.

@androm3da
Clarify the usage example for hexagon-unknown-none-elf
b4a0724 
The C wrapper program represents a typical use case (linking
C libraries with Rust libraries) but it was not made explicit how
this was supposed to work in the usage example.

Also: correct a table alignment error for hexagon-unknown-none-elf on the
general platform support doc.
@androm3da
Add a platform doc for hexagon-unknown-linux-musl
cd47739
@Amanieu
Copy link
Member

Amanieu commented Feb 29, 2024

@bors r+

@bors
Copy link
Contributor

bors commented Feb 29, 2024

📌 Commit cd47739 has been approved by Amanieu

It is now in the queue for this repository.

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Feb 29, 2024
@GuillaumeGomez GuillaumeGomez mentioned this pull request Feb 29, 2024
Merged
bors added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
@bors
Auto merge of rust-lang#121800 - GuillaumeGomez:rollup-wob2qcz, r=Gui…
384d26f 
…llaumeGomez

Rollup of 10 pull requests

Successful merges:

 - rust-lang#118217 (Document which methods on `f64` are precise)
 - rust-lang#119748 (Increase visibility of `join_path` and `split_paths`)
 - rust-lang#121412 (platform docs: clarify hexagon-unknown-none-elf example, add hexagon-unknown-linux-musl)
 - rust-lang#121654 (Fix `async Fn` confirmation for `FnDef`/`FnPtr`/`Closure` types)
 - rust-lang#121700 (CFI: Don't compress user-defined builtin types)
 - rust-lang#121765 (add platform-specific function to get the error number for HermitOS)
 - rust-lang#121781 (bootstrap/format: send larger batches to rustfmt)
 - rust-lang#121788 (bootstrap: fix clap deprecated warnings)
 - rust-lang#121792 (Improve renaming suggestion when item starts with underscore)
 - rust-lang#121793 (Document which methods on `f32` are precise)

r? `@ghost`
`@rustbot` modify labels: rollup
@bors bors merged commit 1ee5453 into rust-lang:master Feb 29, 2024
11 checks passed
@rustbot rustbot added this to the 1.78.0 milestone Feb 29, 2024
rust-timer added a commit to rust-lang-ci/rust that referenced this pull request Feb 29, 2024
@rust-timer
Unrolled build for rust-lang#121412
2112cdc 
Rollup merge of rust-lang#121412 - androm3da:bcain/update_hex_docs_03, r=Amanieu

platform docs: clarify hexagon-unknown-none-elf example, add hexagon-unknown-linux-musl
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Amanieu Amanieu Amanieu left review comments

Assignees

@JohnTitor JohnTitor

Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Milestone
1.78.0
Development

Successfully merging this pull request may close these issues.
6 participants
@androm3da @rustbot @rust-log-analyzer @Amanieu @bors @JohnTitor