diff --git a/src/doc/src/faq.md b/src/doc/src/faq.md index 2a58bdaf45a..2fd3debd63e 100644 --- a/src/doc/src/faq.md +++ b/src/doc/src/faq.md @@ -147,7 +147,7 @@ similar configuration files in directory listings. Sorting files often puts capital letters before lowercase letters, ensuring files like `Makefile` and `Cargo.toml` are placed together. The trailing `.toml` was chosen to emphasize the fact that the file is in the [TOML configuration -format](https://github.com/toml-lang/toml). +format](https://toml.io/). Cargo does not allow other names such as `cargo.toml` or `Cargofile` to emphasize the ease of how a Cargo repository can be identified. An option of diff --git a/src/doc/src/guide/creating-a-new-project.md b/src/doc/src/guide/creating-a-new-project.md index f368e733aac..a66142c1567 100644 --- a/src/doc/src/guide/creating-a-new-project.md +++ b/src/doc/src/guide/creating-a-new-project.md @@ -37,7 +37,8 @@ edition = "2018" ``` This is called a **manifest**, and it contains all of the metadata that Cargo -needs to compile your package. +needs to compile your package. This file is written in the [TOML] format +(pronounced /tɑməl/). Here’s what’s in `src/main.rs`: @@ -89,3 +90,5 @@ $ cargo build --release Compiling in debug mode is the default for development. Compilation time is shorter since the compiler doesn't do optimizations, but the code will run slower. Release mode takes longer to compile, but the code will run faster. + +[TOML]: https://toml.io/ diff --git a/src/doc/src/reference/cargo-targets.md b/src/doc/src/reference/cargo-targets.md index 3968c2e213d..a3a320a4caf 100644 --- a/src/doc/src/reference/cargo-targets.md +++ b/src/doc/src/reference/cargo-targets.md @@ -160,7 +160,7 @@ Similarly to tests: All of the `[lib]`, `[[bin]]`, `[[example]]`, `[[test]]`, and `[[bench]]` sections in `Cargo.toml` support similar configuration for specifying how a target should be built. The double-bracket sections like `[[bin]]` are -array-of-table of [TOML](https://github.com/toml-lang/toml#array-of-tables), +[array-of-table of TOML](https://toml.io/en/v1.0.0-rc.3#array-of-tables), which means you can write more than one `[[bin]]` section to make several executables in your crate. You can only specify one library, so `[lib]` is a normal TOML table. diff --git a/src/doc/src/reference/config.md b/src/doc/src/reference/config.md index 1ff26208c34..cb576e84318 100644 --- a/src/doc/src/reference/config.md +++ b/src/doc/src/reference/config.md @@ -937,7 +937,7 @@ Sets the width for progress bar. [build scripts]: build-scripts.md [`-C linker`]: ../../rustc/codegen-options/index.md#linker [override a build script]: build-scripts.md#overriding-build-scripts -[toml]: https://github.com/toml-lang/toml +[toml]: https://toml.io/ [incremental compilation]: profiles.md#incremental [profile]: profiles.md [libcurl format]: https://ec.haxx.se/usingcurl-proxies.html diff --git a/src/doc/src/reference/manifest.md b/src/doc/src/reference/manifest.md index b8862951666..e544393aa5b 100644 --- a/src/doc/src/reference/manifest.md +++ b/src/doc/src/reference/manifest.md @@ -1,7 +1,7 @@ ## The Manifest Format -The `Cargo.toml` file for each package is called its *manifest*. Every manifest -file consists of the following sections: +The `Cargo.toml` file for each package is called its *manifest*. It is written +in the [TOML] format. Every manifest file consists of the following sections: * [`cargo-features`](unstable.md) — Unstable, nightly-only features. * [`[package]`](#the-package-section) — Defines a package. @@ -516,6 +516,7 @@ more detail. [spdx-2.1-license-expressions]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 [spdx-license-list-3.6]: https://github.com/spdx/license-list-data/tree/v3.6 [SPDX site]: https://spdx.org/license-list +[TOML]: https://toml.io/