-
Notifications
You must be signed in to change notification settings - Fork 13.9k
Closed
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.Category: This is a bug.P-mediumMedium priorityMedium priority
Description
Right now, The Unstable Book is just a list of unstable lang/lib features. There are other things like compiler flags which are also considered unstable that should be documented in The Unstable Book. This requires adjusting the tidy lint a bit to accommodate other sections. Right now I'm thinking that all sections (features, flags, etc) will live in their own subdirectory.
steveklabnik, QuietMisdreavus and japaric
Metadata
Metadata
Assignees
Labels
A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.Category: This is a bug.P-mediumMedium priorityMedium priority
Type
Projects
Milestone
Relationships
Development
Select code repository
Activity
frewsxcv commentedon Apr 7, 2017
Relevant thread: #40018 (comment)
frewsxcv commentedon Apr 7, 2017
Reminder for future self: remove this hack e280515
brson commentedon Apr 8, 2017
This may not be the issue, but there are a number of stable features that are actually just "stable", like target specs and llvm plugins, where we don't even try to maintain stability. It would be nice to have a discussion of those somewhere.
frewsxcv commentedon Apr 9, 2017
I'm waiting on #40018 to merge before I work on this.
frewsxcv commentedon Apr 14, 2017
Copying @est31's text from #41289:
20 remaining items
steveklabnik commentedon Aug 30, 2017
frewsxcv commentedon Sep 16, 2017
regarding unsafe command line options, one can see them via
rustc -Z help
. it looks like the options are all defined in thissrc/librustc/session/config.rs
file. they seem to all be exposed onrustc::session::Session
andrustc::session::config::DebuggingOptions
. seems like we should be able to autogenerate all the unsafe command line options pages like we do for the other unstable book sections (viasrc/tools/unstable-book-gen
)steveklabnik commentedon Jan 8, 2019
Triage: we now have https://doc.rust-lang.org/rustc/command-line-arguments.html, but it doesn't talk about
-Z
.DevQps commentedon Apr 3, 2019
I just saw that the Unstable Book already contains a list of unstable compiler flags here which I guess means that this issue is already solved right?
Maybe we should create a separate issue for the missing -Z description in https://doc.rust-lang.org/rustc/command-line-arguments.html and close this one? Maybe also create a separate issue to autogenerate the unsafe nightly commands for the Unstable Book. That way we can keep the tasks that need to be done clearly isolated.
@steveklabnik If you agree I can create these new issues with a nice description of what needs to be done!
steveklabnik commentedon Apr 3, 2019
Yes! Alternatively, if this is something you'd like to send a PR for, we can just keep this issue open and use that PR to close it.
I would prefer not to, I don't think this is the job for the unstable book.
DevQps commentedon Apr 3, 2019
However, this does lead me to the following question: Currently, there is already a compiler flags section in the unstable book. For example the
-Z emit-stack-sizes
flag. I think we should either try to complete this section or remove/move it to therustc
docs all-together. What is your opinion on this?steveklabnik commentedon Apr 3, 2019
Moving it to the
rustc
docs seems appropriate to me!DevQps commentedon Apr 3, 2019
I created an issue for this here: #59679
Then we can use this issue for adding -Z to the compiler flags section!
Rollup merge of rust-lang#59680 - DevQps:document-rustc-z-flag, r=cra…
Rollup merge of rust-lang#59680 - DevQps:document-rustc-z-flag, r=cra…
Rollup merge of rust-lang#59680 - DevQps:document-rustc-z-flag, r=cra…