]> git.lizzy.rs Git - rust.git/commitdiff
Rename theme-checker option to check-theme
authorGuillaume Gomez <guillaume1.gomez@gmail.com>
Sun, 30 Jun 2019 17:24:32 +0000 (19:24 +0200)
committerGuillaume Gomez <guillaume1.gomez@gmail.com>
Mon, 18 Nov 2019 15:43:48 +0000 (16:43 +0100)
src/doc/rustdoc/src/command-line-arguments.md
src/doc/rustdoc/src/unstable-features.md
src/librustdoc/html/static_files.rs
src/librustdoc/lib.rs
src/tools/rustdoc-themes/main.rs

index 2c25baf373ed269b31b46a5ec4e1092e3f342f56..48fd8272d24f3e78b6a92eb1bb947b7a551a619f 100644 (file)
@@ -368,7 +368,7 @@ you'll need to this flag as follows:
 $ rustdoc src/lib.rs --themes /path/to/your/theme/file.css
 ```
 
-### `theme-checker`: check if your themes implement all the required rules
+### `check-theme`: check if your themes implement all the required rules
 
 This flag allows you to check if your themes implement the necessary CSS rules. To put it more
 simply, when adding a new theme, it needs to implements all the CSS rules present in the "light"
@@ -377,5 +377,5 @@ CSS theme.
 You can use this flag like this:
 
 ```bash
-$ rustdoc src/lib.rs --theme-checker /path/to/your/theme/file.css
+$ rustdoc src/lib.rs --check-theme /path/to/your/theme/file.css
 ```
index f8be04a1087bf87245e7b7f27ad5d3069f468359..ddb6e5910cb2eb8c5128685081c4daf764216505 100644 (file)
@@ -304,14 +304,14 @@ $ rustdoc src/lib.rs -Z unstable-options --themes theme.css
 
 Giving this flag to `rustdoc` will make it copy your theme into the generated crate docs and enable
 it in the theme selector. Note that `rustdoc` will reject your theme file if it doesn't style
-everything the "light" theme does. See `--theme-checker` below for details.
+everything the "light" theme does. See `--check-theme` below for details.
 
-### `--theme-checker`: verify theme CSS for validity
+### `--check-theme`: verify theme CSS for validity
 
 Using this flag looks like this:
 
 ```bash
-$ rustdoc -Z unstable-options --theme-checker theme.css
+$ rustdoc -Z unstable-options --check-theme theme.css
 ```
 
 Before including your theme in crate docs, `rustdoc` will compare all the CSS rules it contains
index 3a2c24b1a967fb216f04ad1cebfbcbad7cb5b73a..9fc1d76185fb7bf6aa12c41efe419c648f9bfe0c 100644 (file)
@@ -59,7 +59,7 @@
 /// The built-in themes given to every documentation site.
 pub mod themes {
     /// The "light" theme, selected by default when no setting is available. Used as the basis for
-    /// the `--theme-checker` functionality.
+    /// the `--check-theme` functionality.
     pub static LIGHT: &'static str = include_str!("static/themes/light.css");
 
     /// The "dark" theme.
index 27bef5db2d6d2740f451940d8e1adf6ca6d7ffa4..03a0f34b39b330d1156f3fa46871883d494c0ae4 100644 (file)
@@ -256,8 +256,8 @@ fn opts() -> Vec<RustcOptGroup> {
                        "additional themes which will be added to the generated docs",
                        "FILES")
         }),
-        stable("theme-checker", |o| {
-            o.optmulti("", "theme-checker",
+        stable("check-theme", |o| {
+            o.optmulti("", "check-theme",
                        "check if given theme is valid",
                        "FILES")
         }),
index 616b5444832c11c56f28ec2ae291b20e4b551ccd..b5be14fb41834ba6b512a0d081486d1d6cd49273 100644 (file)
@@ -39,7 +39,7 @@ fn main() {
         exit(1);
     }
     let status = Command::new(rustdoc_bin)
-                        .args(&["-Z", "unstable-options", "--theme-checker"])
+                        .args(&["-Z", "unstable-options", "--check-theme"])
                         .args(&themes)
                         .status()
                         .expect("failed to execute child");