about summary refs log tree commit diff
path: root/src/bootstrap/doc.rs
AgeCommit message (Collapse)AuthorLines
2017-10-22Auto merge of #45433 - ollie27:rustbuild_nomicon, r=Mark-Simulacrumbors-1/+1
rustbuild: Fix path for the nomicon
2017-10-21rustbuild: Fix path for the nomiconOliver Middleton-1/+1
2017-10-14rustbuild: Don't try to build rustdoc API docs with compiler docsOliver Middleton-5/+3
rustdoc is built separately to rustc now so the docs would need to be generated separately as well. Also rustdoc doesn't build at stage 1 which prevented the compiler docs being built at stage 1.
2017-08-29rustbuild: Don't require cross-compiled error indexAlex Crichton-5/+0
All architectures use the same errors, no need to cross-compile a version only to not look at it.
2017-08-16Implement a temp redirect for cargo docsCarol (Nichols || Goulding)-0/+45
As discussed in https://github.com/rust-lang/cargo/issues/4040#issuecomment-321639074 This is a redirect meant to be replaced once cargo docs have been converted to mdbook. We just want *a* URL to ride the trains for now so that we can print doc.rust-lang.org/cargo in the paper book and guarantee that it will go *somewhere* useful by the time the book is printed. Implemented as a meta redirect in HTML because we don't currently have any google juice at doc.rust-lang.org/cargo to lose.
2017-08-15use field init shorthand EVERYWHEREZack M. Davis-2/+2
Like #43008 (f668999), but _much more aggressive_.
2017-08-15Auto merge of #43863 - steveklabnik:ship-the-rustdoc-book, r=frewsxcvbors-0/+1
Ship the rustdoc book Fixes #42322, as it's the last step. Blocked on https://github.com/rust-lang/rust/pull/43790, though they will not conflict. r? @rust-lang/docs
2017-08-14start building the rustdoc booksteveklabnik-0/+1
2017-08-13Rollup merge of #43814 - Eijebong:fix_typos2, r=petrochenkovGuillaume Gomez-1/+1
Fix some typos Follow up of #43794 If refined my script a little bit and found some more.
2017-08-13Build rustdoc only at the top stageMark Simulacrum-6/+6
2017-08-12Fix some typosBastien Orivel-1/+1
2017-07-27Correct a few run.host invocations where run.target is intended.Mark Simulacrum-2/+2
2017-07-27Allow changing rustdoc which builds the book.Mark Simulacrum-10/+13
2017-07-27Build rustdoc on-demand.Mark Simulacrum-10/+2
Rustdoc is no longer compiled in every stage, alongside rustc, instead it is only compiled when requested, and generally only for the last stage.
2017-07-25Bump master to 1.21.0Alex Crichton-8/+3
This commit bumps the master branch's version to 1.21.0 and also updates the bootstrap compiler from the freshly minted beta release.
2017-07-20Change make_run signature to taking a RunConfig struct for refactorability.Mark Simulacrum-63/+33
2017-07-20Add an optional condition to constrain defaults.Mark Simulacrum-83/+28
Utilized primarily to not be a default rule unless some configuration is given (e.g., compiler docs are enabled).
2017-07-20Remove step.rs commentsMark Simulacrum-97/+0
2017-07-20Change default documentation rules to correspond with previous state.Mark Simulacrum-2/+2
2017-07-20Implement available paths list.Mark Simulacrum-32/+26
2017-07-20Require should_run to be implemented.Mark Simulacrum-0/+11
2017-07-20Make the book default.Mark Simulacrum-0/+1
2017-07-20Utilize interning to allow Copy/Clone stepsMark Simulacrum-84/+95
2017-07-20Remove core_intrinsics feature gateMark Simulacrum-0/+11
2017-07-20Cleanups and fixes throughoutMark Simulacrum-0/+16
2017-07-20Finish fixing warnings and errors. Bootstrap builds.Mark Simulacrum-10/+10
2017-07-20Fixes warnings and errors introduced while moving code aroundMark Simulacrum-26/+27
2017-07-20Change code to work with the new systemMark Simulacrum-40/+284
2017-07-20Move code into Step trait implementations.Mark Simulacrum-267/+384
No changes are introduced to code body. This commit will not build; it is done to permit a better diff in later commits.
2017-07-20Move rule configs out of stepMark Simulacrum-0/+95
2017-07-04Use build.build instead of build.config.buildMark Simulacrum-9/+9
2017-06-17Reintroduce deprecated `collections` crateMurarth-1/+1
2017-06-16Auto merge of #42612 - est31:master, r=nagisabors-3/+24
Autogenerate stubs and SUMMARY.md in the unstable book Removes a speed bump in compiler development by autogenerating stubs for features in the unstable book. See #42454 for discussion. The PR contains three commits, separated in order to make review easy: * The first commit converts the tidy tool from a binary crate to a crate that contains both a library and a binary. In the second commit, we'll use the tidy library * The second and main commit introduces autogeneration of SUMMARY.md and feature stub files * The third commit turns off the tidy lint that checks for features without a stub, and removes the stub files. A separate commit due to the large number of files touched Members of the doc team who wish to document some features can either do this (where `$rustsrc` is the root of the rust repo git checkout): 1. cd to `$rustsrc/src/tools/unstable-book-gen` and then do `cargo run $rustsrc/src $rustsrc/src/doc/unstable-book` to put the stubs into the unstable book 2. cd to `$rustsrc` and run `git ls-files --others --exclude-standard` to list the newly added stubs 3. choose a file to edit, then `git add` it and `git commit` 4. afterwards, remove all changes by the tool by doing `git --reset hard` and `git clean -f` Or they can do this: 1. remove the comment marker in `src/tools/tidy/src/unstable_book.rs` line 122 2. run `./x.py test src/tools/tidy` to list the unstable features which only have stubs 3. revert the change in 1 3. document one of the chosen unstable features The changes done by this PR also allow for further development: * tidy obtains information about tracking issues. We can now forbid differing tracking issues between differing `#![unstable]` annotations. I haven't done this but plan to in a future PR * we now have a general framework for generating stuff for the unstable book at build time. Further changes can autogenerate a list of the API a given library feature exposes. The old way to simply click through the documentation after it has been uploaded to rust-lang.org works as well. r? @nagisa Fixes #42454
2017-06-13Merge crate `collections` into `alloc`Murarth-1/+1
2017-06-14Autogenerate stubs and the summary of the unstable bookest31-3/+24
2017-03-20fix whitespacesteveklabnik-1/+1
2017-03-20Fix up some issues.steveklabnik-1/+14
Becuase I had run a `x.py doc` before doing this work, I had accidentally relied on some files existing in places that they didn't need to be.
2017-03-20Render redirect pages.steveklabnik-0/+9
These pages will help people who have links to the older book.
2017-03-20build book indexsteveklabnik-0/+49
2017-03-20build both editions of the booksteveklabnik-0/+5
2017-03-12rustbuild: Fix compiler docsOliver Middleton-6/+10
* Make sure std docs are generated before compiler docs so rustdoc uses relative links. * Don't document the rustc and rustdoc binary crates as they overwrite the real rustc and rustdoc crates.
2017-03-10rustbuild: Build documentation for `proc_macro`Alex Crichton-9/+58
This commit fixes #38749 by building documentation for the `proc_macro` crate by default for configured hosts. Unfortunately did not turn out to be a trivial fix. Currently rustbuild generates documentation into multiple locations: one for std, one for test, and one for rustc. The initial fix for this issue simply actually executed `cargo doc -p proc_macro` which was otherwise completely elided before. Unfortunately rustbuild was the left to merge two documentation trees together. One for the standard library and one for the rustc tree (which only had docs for the `proc_macro` crate). Rustdoc itself knows how to merge documentation files (specifically around search indexes, etc) but rustbuild was unaware of this, so an initial fix ended up destroying the sidebar and the search bar from the libstd docs. To solve this issue the method of documentation has been tweaked slightly in rustbuild. The build system will not use symlinks (or directory junctions on Windows) to generate all documentation into the same location initially. This'll rely on rustdoc's logic to weave together all the output and ensure that it ends up all consistent. Closes #38749
2017-03-03rustbuild: Add support for compiling CargoAlex Crichton-6/+3
This commit adds support to rustbuild for compiling Cargo as part of the release process. Previously rustbuild would simply download a Cargo snapshot and repackage it. With this change we should be able to turn off artifacts from the rust-lang/cargo repository and purely rely on the artifacts Cargo produces here. The infrastructure added here is intended to be extensible to other components, such as the RLS. It won't exactly be a one-line addition, but the addition of Cargo didn't require too much hooplah anyway. The process for release Cargo will now look like: * The rust-lang/rust repository has a Cargo submodule which is used to build a Cargo to pair with the rust-lang/rust release * Periodically we'll update the cargo submodule as necessary on rust-lang/rust's master branch * When branching beta we'll create a new branch of Cargo (as we do today), and the first commit to the beta branch will be to update the Cargo submodule to this exact revision. * When branching stable, we'll ensure that the Cargo submodule is updated and then make a stable release. Backports to Cargo will look like: * Send a PR to cargo's master branch * Send a PR to cargo's release branch (e.g. rust-1.16.0) * Send a PR to rust-lang/rust's beta branch updating the submodule * Eventually send a PR to rust-lang/rust's master branch updating the submodule For reference, the process to add a new component to the rust-lang/rust release would look like: * Add `$foo` as a submodule in `src/tools` * Add a `tool-$foo` step which compiles `$foo` with the specified compiler, likely mirroring what Cargo does. * Add a `dist-$foo` step which uses `src/tools/$foo` and the `tool-$foo` output to create a rust-installer package for `$foo` likely mirroring what Cargo does. * Update the `dist-extended` step with a new dependency on `dist-$foo` * Update `src/tools/build-manifest` for the new component.
2017-02-24Auto merge of #39851 - alexcrichton:verify-unstable, r=brsonbors-2/+2
test: Verify all sysroot crates are unstable As we continue to add more crates to the compiler and use them to implement various features we want to be sure we're not accidentally expanding the API surface area of the compiler! To that end this commit adds a new `run-make` test which will attempt to `extern crate foo` all crates in the sysroot, verifying that they're all unstable. This commit discovered that the `std_shim` and `test_shim` crates were accidentally stable and fixes the situation by deleting those shims. The shims are no longer necessary due to changes in Cargo that have happened since they were originally incepted.
2017-02-21test: Verify all sysroot crates are unstableAlex Crichton-2/+2
As we continue to add more crates to the compiler and use them to implement various features we want to be sure we're not accidentally expanding the API surface area of the compiler! To that end this commit adds a new `run-make` test which will attempt to `extern crate foo` all crates in the sysroot, verifying that they're all unstable. This commit discovered that the `std_shim` and `test_shim` crates were accidentally stable and fixes the situation by deleting those shims. The shims are no longer necessary due to changes in Cargo that have happened since they were originally incepted.
2017-02-21Start the port of the reference to mdBookSteve Klabnik-4/+0
This only really moves the files, there's a lot more work coming in the next commits. Part of #39588.
2017-02-13Re-implement rustbook in terms of mdbookSteve Klabnik-0/+1
mdbook has a lot of optional dependencies that we don't want, so instead of using it directly, we re-build rustbook to use mdbook as a library. For convenience' sake, we keep the same CLI interface as mdbook; the only difference is that it only accepts build and test subcommands, rather than the full range.
2017-02-02Build libbacktrace/jemalloc only when their timestamps are older than sourcesVadim Petrochenkov-1/+2
2017-01-08Don't restrict docs in compiler-docs modeManish Goregaokar-9/+17
2017-01-07Auto merge of #38858 - ollie27:rustbuild_docs_std, r=alexcrichtonbors-1/+10
rustbuild: Stop building docs for std dependancies Fixes: #38319 r? @alexcrichton