summary refs log tree commit diff
path: root/src/doc/rustdoc
diff options
context:
space:
mode:
authorsteveklabnik <steve@steveklabnik.com>2017-06-05 13:09:19 -0400
committersteveklabnik <steve@steveklabnik.com>2017-06-05 13:09:19 -0400
commit2f0dc04bb5fbb61f66e5cc2d145dfe3f4614a597 (patch)
tree045656ff1a780583f7e03ca62b7badf8ff209ef5 /src/doc/rustdoc
parentfd2cbf9956a8c116b33610a0e74505a80dc88209 (diff)
downloadrust-2f0dc04bb5fbb61f66e5cc2d145dfe3f4614a597.tar.gz
rust-2f0dc04bb5fbb61f66e5cc2d145dfe3f4614a597.zip
address review feedback
Diffstat (limited to 'src/doc/rustdoc')
-rw-r--r--src/doc/rustdoc/src/command-line-arguments.md20
-rw-r--r--src/doc/rustdoc/src/what-is-rustdoc.md8
2 files changed, 10 insertions, 18 deletions
diff --git a/src/doc/rustdoc/src/command-line-arguments.md b/src/doc/rustdoc/src/command-line-arguments.md
index c8a86f1378f..36c1b050dd5 100644
--- a/src/doc/rustdoc/src/command-line-arguments.md
+++ b/src/doc/rustdoc/src/command-line-arguments.md
@@ -30,7 +30,7 @@ This will show `rustdoc`'s version, which will look something
 like this:
 
 ```text
-rustdoc 1.y.0 (hash date)
+rustdoc 1.17.0 (56124baa9 2017-04-24)
 ```
 
 ## `-v`/`--verbose`: more verbose output
@@ -47,18 +47,16 @@ to standard out. What is written depends on the other flags you've passed in.
 For example, with `--version`:
 
 ```text
-$ rustdoc --version -v
-rustdoc 1.y.0 (hash date)
+$ rustdoc --verbose --version
+rustdoc 1.17.0 (56124baa9 2017-04-24)
 binary: rustdoc
 commit-hash: hash
 commit-date: date
 host: host-triple
-release: 1.y.0
-LLVM version: x.y
+release: 1.17.0
+LLVM version: 3.9
 ```
 
-stable(optopt("r", "input-format", "the input type of the specified file",
-                "[rust]")),
 ## `-r`/`--input-format`: input format
 
 This flag is currently ignored; the idea is that `rustdoc` would support various
@@ -69,8 +67,6 @@ file ends in `.md` or `.markdown`, `rustdoc` treats it as a Markdown file.
 Otherwise, it assumes that the input file is Rust.
 
 
-stable(optopt("w", "output-format", "the output type to write",
-                "[html]")),
 ## `-w`/`--output-format`: output format
 
 This flag is currently ignored; the idea is that `rustdoc` would support
@@ -92,7 +88,6 @@ the current working directory. With this flag, it will place all output
 into the directory you specify.
 
 
-stable(optopt("", "crate-name", "specify the name of this crate", "NAME")),
 ## `--crate-name`: controlling the name of the crate
 
 Using this flag looks like this:
@@ -105,8 +100,6 @@ By default, `rustodc` assumes that the name of your crate is the same name
 as the `.rs` file. `--crate-name` lets you override this assumption with
 whatever name you choose.
 
-stable(optmulti("L", "library-path", "directory to add to crate search path",
-                "DIR")),
 ## `-L`/`--library-path`: 
 
 Using this flag looks like this:
@@ -219,8 +212,6 @@ on documentation tests](documentation-tests.html).
 
 See also `--test-args`.
 
-stable(optmulti("", "test-args", "arguments to pass to the test runner",
-                "ARGS")),
 ## `--test-args`: 
 
 Using this flag looks like this:
@@ -234,7 +225,6 @@ For more, see [the chapter on documentation tests](documentation-tests.html).
 
 See also `--test`.
 
-stable(optopt("", "target", "target triple to document", "TRIPLE")),
 ## `--target`: 
 
 Using this flag looks like this:
diff --git a/src/doc/rustdoc/src/what-is-rustdoc.md b/src/doc/rustdoc/src/what-is-rustdoc.md
index 1cffbd51b4a..09bf8f388e2 100644
--- a/src/doc/rustdoc/src/what-is-rustdoc.md
+++ b/src/doc/rustdoc/src/what-is-rustdoc.md
@@ -1,6 +1,6 @@
 # What is rustdoc?
 
-The standard Rust distribution ships with a tool called `rustdoc`. It's job is
+The standard Rust distribution ships with a tool called `rustdoc`. Its job is
 to generate documentation for Rust projects. On a fundamental level, Rustdoc
 takes as an argument either a crate root or a Markdown file, and produces HTML,
 CSS, and JavaScript.
@@ -10,7 +10,7 @@ CSS, and JavaScript.
 Let's give it a try! Let's create a new project with Cargo:
 
 ```bash
-$ cargo new docs -- lib
+$ cargo new docs
 $ cd docs
 ```
 
@@ -52,7 +52,7 @@ our code...
 
 ```rust
 /// foo is a function
-fn foo() {}
+pub fn foo() {}
 ```
 
 ... and then re-run `rustdoc`:
@@ -82,6 +82,8 @@ $ rustdoc --crate-name docs srclib.rs -o <path>\docs\target\doc -L
 dependency=<path>docs\target\debug\deps
 ```
 
+You can see this with `cargo doc --verbose`.
+
 It generates the correct `--crate-name` for us, as well as pointing to
 `src/lib.rs` But what about those other arguments? `-o` controls the
 *o*utput of our docs. Instead of a top-level `doc` directory, you'll