Skip to content

Commit c3accbb

Browse files
committed
Auto merge of #14144 - ehuss:config-curly-quotes, r=weihanglo
Docs: Fix curly quotes in config docs. mdBook automatically converts the "quotation mark" character to use smart quotes such as “example”. This isn't valid TOML syntax, and means you can't copy and paste these values. This wraps these TOML strings as code spans so that this conversion doesn't happen (and helps emphasize these are literal code spans).
2 parents 4ed7bee + b581b7a commit c3accbb

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

src/doc/src/reference/config.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Can be overridden with the `--jobs` CLI option.
396396

397397
#### `build.rustc`
398398
* Type: string (program path)
399-
* Default: "rustc"
399+
* Default: `"rustc"`
400400
* Environment: `CARGO_BUILD_RUSTC` or `RUSTC`
401401

402402
Sets the executable to use for `rustc`.
@@ -426,7 +426,7 @@ the final invocation is `$RUSTC_WRAPPER $RUSTC_WORKSPACE_WRAPPER $RUSTC`.
426426

427427
#### `build.rustdoc`
428428
* Type: string (program path)
429-
* Default: "rustdoc"
429+
* Default: `"rustdoc"`
430430
* Environment: `CARGO_BUILD_RUSTDOC` or `RUSTDOC`
431431

432432
Sets the executable to use for `rustdoc`.
@@ -453,7 +453,7 @@ target = ["x86_64-unknown-linux-gnu", "i686-unknown-linux-gnu"]
453453

454454
#### `build.target-dir`
455455
* Type: string (path)
456-
* Default: "target"
456+
* Default: `"target"`
457457
* Environment: `CARGO_BUILD_TARGET_DIR` or `CARGO_TARGET_DIR`
458458

459459
The path to where all compiler output is placed. The default if not specified
@@ -601,7 +601,7 @@ This option is deprecated and unused.
601601

602602
#### `cargo-new.vcs`
603603
* Type: string
604-
* Default: "git" or "none"
604+
* Default: `"git"` or `"none"`
605605
* Environment: `CARGO_CARGO_NEW_VCS`
606606

607607
Specifies the source control system to use for initializing a new repository.
@@ -639,7 +639,7 @@ The `[future-incompat-report]` table controls setting for [future incompat repor
639639

640640
#### `future-incompat-report.frequency`
641641
* Type: string
642-
* Default: "always"
642+
* Default: `"always"`
643643
* Environment: `CARGO_FUTURE_INCOMPAT_REPORT_FREQUENCY`
644644

645645
Controls how often we display a notification to the terminal when a future incompat report is available. Possible values:
@@ -705,15 +705,15 @@ performed. This only works on Windows.
705705
* Environment: `CARGO_HTTP_SSL_VERSION`
706706

707707
This sets the minimum TLS version to use. It takes a string, with one of the
708-
possible values of "default", "tlsv1", "tlsv1.0", "tlsv1.1", "tlsv1.2", or
709-
"tlsv1.3".
708+
possible values of `"default"`, `"tlsv1"`, `"tlsv1.0"`, `"tlsv1.1"`, `"tlsv1.2"`, or
709+
`"tlsv1.3"`.
710710

711711
This may alternatively take a table with two keys, `min` and `max`, which each
712712
take a string value of the same kind that specifies the minimum and maximum
713713
range of TLS versions to use.
714714

715-
The default is a minimum version of "tlsv1.0" and a max of the newest version
716-
supported on your platform, typically "tlsv1.3".
715+
The default is a minimum version of `"tlsv1.0"` and a max of the newest version
716+
supported on your platform, typically `"tlsv1.3"`.
717717

718718
#### `http.low-speed-limit`
719719
* Type: integer
@@ -1284,7 +1284,7 @@ Specifying the `--verbose` flag will override and force verbose output.
12841284

12851285
#### `term.color`
12861286
* Type: string
1287-
* Default: "auto"
1287+
* Default: `"auto"`
12881288
* Environment: `CARGO_TERM_COLOR`
12891289

12901290
Controls whether or not colored output is used in the terminal. Possible values:
@@ -1312,7 +1312,7 @@ Control whether output can be rendered using non-ASCII unicode characters.
13121312

13131313
#### `term.progress.when`
13141314
* Type: string
1315-
* Default: "auto"
1315+
* Default: `"auto"`
13161316
* Environment: `CARGO_TERM_PROGRESS_WHEN`
13171317

13181318
Controls whether or not progress bar is shown in the terminal. Possible values:

0 commit comments

Comments
 (0)