Skip to content

add Miri to rustc rustdoc page #98714

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
Closed
wants to merge 3 commits into from
Closed

add Miri to rustc rustdoc page #98714

wants to merge 3 commits into from

Conversation

RalfJung
Copy link
Member

Based on #97773 by @InfRandomness
r? @jyn514

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jun 30, 2022
@RalfJung RalfJung mentioned this pull request Jun 30, 2022
Closed
@RalfJung RalfJung changed the title genrate Miri rustdoc add Miri to rustc rustdoc page Jun 30, 2022
@jyn514 jyn514 added T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-miri Area: The miri tool labels Jun 30, 2022
@jyn514
Copy link
Member

jyn514 commented Jun 30, 2022

@RalfJung can you double check that x doc src/tools/miri works for you locally? I saw you added the try_run to make it optional, which is great, but I think we should at least have no warnings initially if we can help it.

@jyn514 jyn514 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 Jun 30, 2022
@b-NC
Copy link
Contributor

b-NC commented Jun 30, 2022 •
edited
Loading

It's good that someone kept the changes in backup somewhere, I completely lost 'em and couldn't figure out how to do it again
Would it be possible to be marked as co author of the commits I did ?

@RalfJung
Copy link
Member Author

RalfJung commented Jun 30, 2022 •
edited
Loading 

 Documenting miri v0.1.0 (/home/r/src/rust/rustc.2/src/tools/miri)
    Finished release [optimized + debuginfo] target(s) in 41.43s
Build completed successfully in 0:12:23

Seems to work fine.

@InfRandomness you are marked as their author. See e.g. c113fbe: "infrandomness authored and RalfJung committed". It looks like you used an email address for those commits that is not associated with your Github account, that's why it cannot link to that.

@jyn514
Copy link
Member

jyn514 commented Jun 30, 2022

@bors r+

@bors
Copy link
Collaborator

bors commented Jun 30, 2022

📌 Commit c25d566 has been approved by jyn514

@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-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Jun 30, 2022
@b-NC
Copy link
Contributor

b-NC commented Jun 30, 2022 

 Documenting miri v0.1.0 (/home/r/src/rust/rustc.2/src/tools/miri)
    Finished release [optimized + debuginfo] target(s) in 41.43s
Build completed successfully in 0:12:23

Seems to work fine.

@InfRandomness you are marked as their author. See e.g. c113fbe: "infrandomness authored and RalfJung committed". It looks like you used an email address for those commits that is not associated with your Github account, that's why it cannot link to that.

that's weird
I use the same email on both, oh well, it still says my username so is okay

@b-NC
Copy link
Contributor

b-NC commented Jun 30, 2022

Ah I know what happened, I put a lowercased username in, I think that's because of that,
can it be corrected or is it too late ?

@RalfJung
Copy link
Member Author

RalfJung commented Jun 30, 2022 •
edited
Loading

If you produce commits with fixed emails in your fork, I can cherry-pick them. (But this PR might get rolled up any time and then it will be too late.)

@b-NC
Copy link
Contributor

b-NC commented Jul 1, 2022 •
edited
Loading

If you produce commits with fixed emails in your fork, I can cherry-pick them. (But this PR might get rolled up any time and then it will be too late.)

My fork is completely destroyed, can I fork your fork, rebase / edit and then have you cherry-pick it ?

@jyn514
Copy link
Member

jyn514 commented Jul 1, 2022

This is not going to be any easier than the initial submodule stuff that gave you trouble.

@RalfJung
Copy link
Member Author

RalfJung commented Jul 1, 2022

My fork is completely destroyed,

Your Github fork is fine. Your local copy of it might be busted, but you can just delete that and re-clone.

@RalfJung
Copy link
Member Author

RalfJung commented Jul 1, 2022

If you want to try that, fine with me.
@bors r-

@bors bors 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-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Jul 1, 2022
@b-NC
Copy link
Contributor

b-NC commented Jul 1, 2022 •
edited
Loading

@RalfJung Okay I have successfully changed the author on my fork ! 😄
Thanks for bothering with all of that, it's all good now

@RalfJung
Copy link
Member Author

RalfJung commented Jul 1, 2022

Nice. :) So do you want to create a PR from your branch https://github.com/InfRandomness/rust/tree/miri-rustdoc ?

@b-NC b-NC mentioned this pull request Jul 1, 2022
Merged
@b-NC
Copy link
Contributor

b-NC commented Jul 1, 2022

Nice. :) So do you want to create a PR from your branch https://github.com/InfRandomness/rust/tree/miri-rustdoc ?

Yep, done !

@jyn514 jyn514 closed this Jul 1, 2022
@RalfJung
Copy link
Member Author

RalfJung commented Jul 1, 2022 

 Yep, done !

For future reference: #98764

@RalfJung RalfJung deleted the miri-rustdoc branch July 1, 2022 14:31
RalfJung added a commit to RalfJung/rust that referenced this pull request Jul 3, 2022
@RalfJung
Rollup merge of rust-lang#98764 - InfRandomness:miri-rustdoc, r=jyn514
8974fa3 
add Miri to the nightly docs

This is a follow-up to rust-lang#97773 and to rust-lang#98714

It adds miri to the doc.rust-lang.org/nightly/nightly-rustc](https://doc.rust-lang.org/nightly/nightly-rustc/
RalfJung added a commit to RalfJung/rust that referenced this pull request Jul 3, 2022
@RalfJung
Rollup merge of rust-lang#98764 - InfRandomness:miri-rustdoc, r=jyn514
b0d831a 
add Miri to the nightly docs

This is a follow-up to rust-lang#97773 and to rust-lang#98714

It adds miri to the doc.rust-lang.org/nightly/nightly-rustc](https://doc.rust-lang.org/nightly/nightly-rustc/
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@jyn514 jyn514

Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools A-miri Area: The miri tool S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@RalfJung @jyn514 @b-NC @bors @rust-highfive