about summary refs log tree commit diff
diff options
context:
space:
mode:
authorbors <bors@rust-lang.org>2017-08-15 07:28:54 +0000
committerbors <bors@rust-lang.org>2017-08-15 07:28:54 +0000
commitc774c9591959edc9aa098e5ff7fc4be2e4a12c09 (patch)
treec4a930f96f6e2f0cb5b9efe5c5abca40819462c1
parentf6a30bd37b68d4d474fa3c3b49df29637fe3c369 (diff)
parent2c6cf22a30bf09eb5183b1326e6c74347df72f77 (diff)
downloadrust-c774c9591959edc9aa098e5ff7fc4be2e4a12c09.tar.gz
rust-c774c9591959edc9aa098e5ff7fc4be2e4a12c09.zip
Auto merge of #43863 - steveklabnik:ship-the-rustdoc-book, r=frewsxcv
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
-rw-r--r--src/bootstrap/builder.rs2
-rw-r--r--src/bootstrap/doc.rs1
-rw-r--r--src/doc/index.md2
-rw-r--r--src/doc/rustdoc/src/SUMMARY.md3
-rw-r--r--src/doc/rustdoc/src/command-line-arguments.md28
-rw-r--r--src/doc/rustdoc/src/plugins.md3
6 files changed, 6 insertions, 33 deletions
diff --git a/src/bootstrap/builder.rs b/src/bootstrap/builder.rs
index 5f1830081ad..91dddc7b5bc 100644
--- a/src/bootstrap/builder.rs
+++ b/src/bootstrap/builder.rs
@@ -257,7 +257,7 @@ impl<'a> Builder<'a> {
             Kind::Bench => describe!(check::Crate, check::CrateLibrustc),
             Kind::Doc => describe!(doc::UnstableBook, doc::UnstableBookGen, doc::TheBook,
                 doc::Standalone, doc::Std, doc::Test, doc::Rustc, doc::ErrorIndex, doc::Nomicon,
-                doc::Reference),
+                doc::Reference, doc::Rustdoc),
             Kind::Dist => describe!(dist::Docs, dist::Mingw, dist::Rustc, dist::DebuggerScripts,
                 dist::Std, dist::Analysis, dist::Src, dist::PlainSourceTarball, dist::Cargo,
                 dist::Rls, dist::Extended, dist::HashSign),
diff --git a/src/bootstrap/doc.rs b/src/bootstrap/doc.rs
index 81a3845ecf7..05c7d689f2c 100644
--- a/src/bootstrap/doc.rs
+++ b/src/bootstrap/doc.rs
@@ -68,6 +68,7 @@ macro_rules! book {
 book!(
     Nomicon, "src/doc/book", "nomicon";
     Reference, "src/doc/reference", "reference";
+    Rustdoc, "src/doc/rustdoc", "rustdoc";
 );
 
 #[derive(Debug, Copy, Clone, Hash, PartialEq, Eq)]
diff --git a/src/doc/index.md b/src/doc/index.md
index fd5b120e81f..bfd09145baa 100644
--- a/src/doc/index.md
+++ b/src/doc/index.md
@@ -31,6 +31,7 @@ nicknamed 'The Rust Bookshelf.'
 * [The Unstable Book][unstable-book] has documentation for unstable features.
 * [The Rustonomicon][nomicon] is your guidebook to the dark arts of unsafe Rust.
 * [The Reference][ref] is not a formal spec, but is more detailed and comprehensive than the book.
+* [The Rustdoc Book][rustdoc-book] describes our documentation tool, `rustdoc`.
 
 Initially, documentation lands in the Unstable Book, and then, as part of the
 stabilization process, is moved into the Book, Nomicon, or Reference.
@@ -51,4 +52,5 @@ before this policy was put into place. That work is being tracked
 [book]: book/index.html
 [nomicon]: nomicon/index.html
 [unstable-book]: unstable-book/index.html
+[rustdoc-book]: rustdoc/index.html
 
diff --git a/src/doc/rustdoc/src/SUMMARY.md b/src/doc/rustdoc/src/SUMMARY.md
index 1049cc4284a..6315cb81a84 100644
--- a/src/doc/rustdoc/src/SUMMARY.md
+++ b/src/doc/rustdoc/src/SUMMARY.md
@@ -4,5 +4,4 @@
 - [Command-line arguments](command-line-arguments.md)
 - [The `#[doc]` attribute](the-doc-attribute.md)
 - [Documentation tests](documentation-tests.md)
-- [Plugins](plugins.md)
-- [Passes](passes.md)
\ No newline at end of file
+- [Passes](passes.md)
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md
index 36c1b050dd5..0f0bda65ce3 100644
--- a/src/doc/rustdoc/src/command-line-arguments.md
+++ b/src/doc/rustdoc/src/command-line-arguments.md
@@ -141,20 +141,6 @@ Similar to `--library-path`, `--extern` is about specifying the location
 of a dependency. `--library-path` provides directories to search in, `--extern`
 instead lets you specify exactly which dependency is located where.
 
-
-## `--plugin-path`: loading plugins
-
-Using this flag looks like this:
-
-```bash
-$ rustdoc src/lib.rs --plugin-path=/path/to/plugins
-```
-
-Similar to `--library-path`, but for plugins. For more, see
-the [chapter on plugins](plugins.html).
-
-See also: `--plugins`.
-
 ## `--passes`: add more rustdoc passes
 
 Using this flag looks like this:
@@ -171,18 +157,6 @@ For more details on passes, see [the chapter on them](passes.html).
 
 See also `--no-defaults`.
 
-## `--plugins`: 
-
-Using this flag looks like this:
-
-```bash
-$ rustdoc src/lib.rs --plugins foo bar
-```
-
-For more, see the [chapter on plugins](plugins.html).
-
-See also: `--plugin-path`.
-
 ## `--no-defaults`: don't run default passes
 
 Using this flag looks like this:
@@ -345,4 +319,4 @@ $ rustdoc src/lib.rs --sysroot /path/to/sysroot
 ```
 
 Similar to `rustc --sysroot`, this lets you change the sysroot `rustdoc` uses
-when compiling your code.
\ No newline at end of file
+when compiling your code.
diff --git a/src/doc/rustdoc/src/plugins.md b/src/doc/rustdoc/src/plugins.md
deleted file mode 100644
index c0d5ed752c6..00000000000
--- a/src/doc/rustdoc/src/plugins.md
+++ /dev/null
@@ -1,3 +0,0 @@
-# Plugins
-
-Coming soon!
\ No newline at end of file