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.

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

Move the compiler flags in the unstable book to the rustc book #59679

Open
DevQps opened this issue Apr 3, 2019 · 0 comments
Open

Move the compiler flags in the unstable book to the rustc book #59679

DevQps opened this issue Apr 3, 2019 · 0 comments
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-frontend Area: frontend (errors, parsing and HIR) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.

Comments

@DevQps
Copy link
Contributor

DevQps commented Apr 3, 2019

Description

Currently the unstable book contains three sections:

  • Unstable compiler flags
  • Unstable language features
  • Unstable library features.

As has been mentioned in #41142 it might be better to move the unstable compiler flags to the rustc book. I see the following reasons why:

  • Compiler flags are already mentioned in the rustc book to keep documentation close together I believe it would make sense to keep all compiler flags close together. In order to avoid documentation duplication (which is hard to maintain), I believe placing them in the rustc book is more logical then not mentioning them in the rustc book and only having them in the unstable book.

  • It seems that the unstable compiler flags in the unstable book are not maintained, unless there are only two unstable compiler flags (which I believe is not true since -Z lists many options).

I'd like to hear your opinion on this and, if you agree, under which section we should place this documentation. We could also aim to automize the generation of these nightly compiler flags?

@jonas-schievink jonas-schievink added C-enhancement Category: An issue proposing an enhancement or a PR with one. A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Apr 3, 2019
@jonas-schievink jonas-schievink added A-frontend Area: frontend (errors, parsing and HIR) T-compiler Relevant to the compiler team, which will review and decide on the PR/issue. labels Mar 6, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-frontend Area: frontend (errors, parsing and HIR) C-enhancement Category: An issue proposing an enhancement or a PR with one. T-compiler Relevant to the compiler team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

2 participants