diff --git a/src/doc/src/guide/dependencies.md b/src/doc/src/guide/dependencies.md index a6d129a359d..9ca6061e684 100644 --- a/src/doc/src/guide/dependencies.md +++ b/src/doc/src/guide/dependencies.md @@ -71,7 +71,7 @@ we choose to `cargo update`. You can now use the `regex` library in `main.rs`. -```rust +```rust,ignore use regex::Regex; fn main() { diff --git a/src/doc/src/reference/build-script-examples.md b/src/doc/src/reference/build-script-examples.md index bd7f9e1e3d5..03eb9213a2d 100644 --- a/src/doc/src/reference/build-script-examples.md +++ b/src/doc/src/reference/build-script-examples.md @@ -30,7 +30,7 @@ library call as part of the build script. First, let’s take a look at the directory structure of this package: -``` +```text . ├── Cargo.toml ├── build.rs @@ -128,7 +128,7 @@ a Rust library which calls into C to print “Hello, World!”. Like above, let’s first take a look at the package layout: -``` +```text . ├── Cargo.toml ├── build.rs diff --git a/src/doc/src/reference/cargo-targets.md b/src/doc/src/reference/cargo-targets.md index ebff8be475d..3968c2e213d 100644 --- a/src/doc/src/reference/cargo-targets.md +++ b/src/doc/src/reference/cargo-targets.md @@ -334,7 +334,7 @@ situations. For example, if you have a library where you want a *module* named compile anything in the `bin` directory as an executable. Here is a sample layout of this scenario: -``` +```text ├── Cargo.toml └── src    ├── lib.rs diff --git a/src/doc/src/reference/environment-variables.md b/src/doc/src/reference/environment-variables.md index 375ee9871b8..fc580e22fc4 100644 --- a/src/doc/src/reference/environment-variables.md +++ b/src/doc/src/reference/environment-variables.md @@ -166,7 +166,7 @@ Note that this applies for running binaries with `cargo run` and `cargo test` as well. To get the value of any of these variables in a Rust program, do this: -```rust +```rust,ignore let version = env!("CARGO_PKG_VERSION"); ``` @@ -235,7 +235,7 @@ Cargo sets several environment variables when build scripts are run. Because the are not yet set when the build script is compiled, the above example using `env!` won't work and instead you'll need to retrieve the values when the build script is run: -```rust +```rust,ignore use std::env; let out_dir = env::var("OUT_DIR").unwrap(); ``` diff --git a/src/doc/src/reference/publishing.md b/src/doc/src/reference/publishing.md index 3f01dd16f1a..98c94115451 100644 --- a/src/doc/src/reference/publishing.md +++ b/src/doc/src/reference/publishing.md @@ -221,7 +221,9 @@ for permission if [crates.io] doesn’t have all the scopes it would like to. An additional barrier to querying GitHub is that the organization may be actively denying third party access. To check this, you can go to: - https://github.com/organizations/:org/settings/oauth_application_policy +```text +https://github.com/organizations/:org/settings/oauth_application_policy +``` where `:org` is the name of the organization (e.g., `rust-lang`). You may see something like: diff --git a/src/doc/src/reference/registries.md b/src/doc/src/reference/registries.md index 6b49cd0dc05..675645ce11d 100644 --- a/src/doc/src/reference/registries.md +++ b/src/doc/src/reference/registries.md @@ -38,7 +38,7 @@ As with most config values, the index may be specified with an environment variable instead of a config file. For example, setting the following environment variable will accomplish the same thing as defining a config file: -``` +```ignore CARGO_REGISTRIES_MY_REGISTRY_INDEX=https://my-intranet:8080/git/index ``` diff --git a/src/doc/src/reference/specifying-dependencies.md b/src/doc/src/reference/specifying-dependencies.md index 28c83b93f45..b770b0ed6b4 100644 --- a/src/doc/src/reference/specifying-dependencies.md +++ b/src/doc/src/reference/specifying-dependencies.md @@ -398,7 +398,7 @@ baz = { version = "0.1", registry = "custom", package = "foo" } In this example, three crates are now available in your Rust code: -```rust +```rust,ignore extern crate foo; // crates.io extern crate bar; // git repository extern crate baz; // registry `custom` diff --git a/src/doc/src/reference/unstable.md b/src/doc/src/reference/unstable.md index 6532b8c0768..db1b6d0dc62 100644 --- a/src/doc/src/reference/unstable.md +++ b/src/doc/src/reference/unstable.md @@ -82,7 +82,7 @@ exact filename can be tricky since you need to parse JSON output. The that the artifacts are copied, so the originals are still in the `target` directory. Example: -``` +```sh cargo +nightly build --out-dir=out -Z unstable-options ``` @@ -105,7 +105,7 @@ while also passing it a `--target` option, as well as enabling `-Zunstable-features --enable-per-target-ignores` and passing along information from `.cargo/config.toml`. See the rustc issue for more information. -``` +```sh cargo test --target foo -Zdoctest-xcompile ``` @@ -163,7 +163,7 @@ profiles from which the custom profile inherits are inherited too. For example, using `cargo build` with `--profile` and the manifest from above: -``` +```sh cargo +nightly build --profile release-lto -Z unstable-options ``` @@ -223,7 +223,7 @@ information about which commands would be run without actually executing anything. This can be useful when integrating with another build tool. Example: -``` +```sh cargo +nightly build --build-plan -Z unstable-options ``` @@ -296,7 +296,7 @@ need to have the source code for the standard library available, and at this time the only supported method of doing so is to add the `rust-src` rust rustup component: -``` +```console $ rustup component add rust-src --toolchain nightly ``` @@ -306,7 +306,7 @@ just forced to pass `--target` in one form or another. Usage looks like: -``` +```console $ cargo new foo $ cd foo $ cargo +nightly run -Z build-std --target x86_64-unknown-linux-gnu @@ -326,7 +326,7 @@ Using `-Z build-std` will implicitly compile the stable crates `core`, `std`, `test` crate. If you're working with an environment which does not support some of these crates, then you can pass an argument to `-Zbuild-std` as well: -``` +```console $ cargo +nightly build -Z build-std=core,alloc ``` @@ -373,7 +373,7 @@ override the default list of features enabled. The `timings` feature gives some information about how long each compilation takes, and tracks concurrency information over time. -``` +```sh cargo +nightly build -Z timings ``` @@ -470,7 +470,7 @@ variables, which take precedence over config files. Some examples of what it looks like using Bourne shell syntax: -```sh +```console # Most shells will require escaping. cargo --config http.proxy=\"http://example.com\" …