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

Add top level sections to the Unstable Book. #41295

Merged
merged 3 commits into from
Apr 20, 2017

Conversation

frewsxcv
Copy link
Member

@frewsxcv frewsxcv commented Apr 14, 2017

Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: #41142.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@frewsxcv frewsxcv force-pushed the frewsxcxv-unstability branch 2 times, most recently from e578268 to 4592345 Compare April 14, 2017 03:04
@frewsxcv frewsxcv added the A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools label Apr 14, 2017
@@ -2,6 +2,3 @@
name = "tidy"
version = "0.1.0"
authors = ["Alex Crichton <alex@alexcrichton.com>"]

[dependencies]
regex = "0.2"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a Cargo.lock file here needs to be updated presumably because of this change.

@steveklabnik
Copy link
Member

While we're doing this, should language features vs library features also happen?

@shepmaster shepmaster added the S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. label Apr 14, 2017
@frewsxcv
Copy link
Member Author

While we're doing this, should language features vs library features also happen?

Yeah, I can do that.

@bors
Copy link
Contributor

bors commented Apr 15, 2017

☔ The latest upstream changes (presumably #41305) made this pull request unmergeable. Please resolve the merge conflicts.

@frewsxcv frewsxcv force-pushed the frewsxcxv-unstability branch 3 times, most recently from 66aa506 to ae71ca1 Compare April 15, 2017 19:03
@frewsxcv
Copy link
Member Author

@steveklabnik How does this look?

@frewsxcv
Copy link
Member Author

If anyone has any idea what's going on with the linkchecker here, please let me know

@frewsxcv
Copy link
Member Author

I fixed most of the tidy lint issues, I had to disable linkchecker for the Unstable Book (for now), since I'm using a subdirectory which mdbook uses <base> for which linkchecker doesn't support.

The remaining issues are here:

book/compiler-plugins.html:32: broken link - unstable-book/plugin.html
book/first-edition/print.html:8645: broken link - unstable-book/intrinsics.html
book/first-edition/print.html:13986: broken link - unstable-book/lang-items.html
book/first-edition/unsafe.html:188: broken link - unstable-book/intrinsics.html
book/first-edition/using-rust-without-the-standard-library.html:79: broken link - unstable-book/lang-items.html
reference/attributes.html:392: broken link - unstable-book/plugin.html
reference/macros.html:80: broken link - unstable-book/plugin.html
reference/print.html:559: broken link - unstable-book/plugin.html
reference/print.html:2193: broken link - unstable-book/plugin.html

These require changes upstream to the book and reference. What's the recommended approach? Set up redirects for everything?

@bors
Copy link
Contributor

bors commented Apr 16, 2017

☔ The latest upstream changes (presumably #40409) made this pull request unmergeable. Please resolve the merge conflicts.

@steveklabnik
Copy link
Member

steveklabnik commented Apr 17, 2017

These require changes upstream to the book and reference. What's the recommended approach? Set up redirects for everything?

We say this PR is good to go, then you update the submodules in this PR and ship it together. let's do that

@frewsxcv
Copy link
Member Author

We say this PR is good to go

Sooooo is this PR good to go? ;) I can take care of the merge conflict, though they're going to keep popping up until this (and the book/reference PRs) gets shipped

@steveklabnik
Copy link
Member

Yes, conceptually this PR is good to go; as long as you can take care of all of it within this week (due to beta branching), then let's do it.

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 18, 2017
…teveklabnik

Add top level sections to the Unstable Book.

Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: rust-lang#41142.
Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: rust-lang#41142.
@frewsxcv
Copy link
Member Author

@bors r=steveklabnik

@bors
Copy link
Contributor

bors commented Apr 19, 2017

📌 Commit bf202c8 has been approved by steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 19, 2017
…teveklabnik

Add top level sections to the Unstable Book.

Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: rust-lang#41142.
@eddyb
Copy link
Member

eddyb commented Apr 19, 2017

@bors r- Likely responsible for #41387 (comment)

@frewsxcv
Copy link
Member Author

@bors r=steveklabnik

fixed with 2e2a670

@bors
Copy link
Contributor

bors commented Apr 19, 2017

📌 Commit 2e2a670 has been approved by steveklabnik

frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 19, 2017
…teveklabnik

Add top level sections to the Unstable Book.

Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: rust-lang#41142.
frewsxcv added a commit to frewsxcv/rust that referenced this pull request Apr 20, 2017
…teveklabnik

Add top level sections to the Unstable Book.

Prior to this commit, the contents of the Unstable Book were assumed to
be unstable features. This commit moves features into 'language features'
or 'library features' subsections. It also moves the 'linker_flavor'
compiler flag into a new 'Compiler Flags' subsection.

Even though it was helpful, I removed the tidy check that
cross-references the SUMMARY.md links with the Unstable Book directory
contents just because it would be difficult to maintain.

Relevant PR: rust-lang#41142.
bors added a commit that referenced this pull request Apr 20, 2017
Rollup of 7 pull requests

- Successful merges: #41295, #41348, #41374, #41380, #41391, #41398, #41403
- Failed merges: #41376
@bors bors merged commit 2e2a670 into rust-lang:master Apr 20, 2017
gypsydave5 pushed a commit to gypsydave5/book that referenced this pull request Nov 17, 2017
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 S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants