From 6a2889d8ce07414c4d84ddc00fa9d13e983fe58f Mon Sep 17 00:00:00 2001 From: Brandon Pollack Date: Tue, 10 Jan 2023 13:10:16 +0900 Subject: [PATCH 1/3] Add more info and footnotes to rust-ecosystem.md --- src/cargo/rust-ecosystem.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/src/cargo/rust-ecosystem.md b/src/cargo/rust-ecosystem.md index cb15db5da13d..1db06346316e 100644 --- a/src/cargo/rust-ecosystem.md +++ b/src/cargo/rust-ecosystem.md @@ -3,12 +3,12 @@ The Rust ecosystem consists of a number of tools, of which the main ones are: * `rustc`: the Rust compiler which turns `.rs` files into binaries and other - intermediate formats. + intermediate formats[^rustc]. * `cargo`: the Rust dependency manager and build tool. Cargo knows how to download dependencies hosted on and it will pass them to `rustc` when building your project. Cargo also comes with a built-in test - runner which is used to execute unit tests. + runner which is used to execute unit tests[^cargo]. * `rustup`: the Rust toolchain installer and updater. This tool is used to install and update `rustc` and `cargo` when new versions of Rust is released. @@ -44,3 +44,7 @@ Key points: [editions]: https://doc.rust-lang.org/edition-guide/ + +[^rustc]: Please note, it is quite rare to ever use the compiler directly not through `cargo`. + +[^cargo]: Cargo itself is a powerful and comprehensive tool capable of many advanced features including but not limited to: Project structure, [workspaces](https://doc.rust*lang.org/cargo/reference/workspaces.html), dev dependencies, [build scripting](https://doc.rust-lang.org/cargo/reference/build-scripts.html), [binary installation](https://doc.rust-lang.org/cargo/commands/cargo-install.html), etc. It is extensible with sub command plugins as well (such as [cargo clippy](https://github.com/rust-lang/rust-clippy) or [cargo binstall](https://github.com/cargo-bins/cargo-binstall)). Read more from the [official Cargo Book](https://doc.rust-lang.org/cargo/) From c2c3d4892009bf4b0e011fa346a7345f519be93d Mon Sep 17 00:00:00 2001 From: Brandon Pollack Date: Tue, 10 Jan 2023 22:17:18 +0900 Subject: [PATCH 2/3] moved footnotes to speaker notes --- src/cargo/rust-ecosystem.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/src/cargo/rust-ecosystem.md b/src/cargo/rust-ecosystem.md index 1db06346316e..68f91ba438b2 100644 --- a/src/cargo/rust-ecosystem.md +++ b/src/cargo/rust-ecosystem.md @@ -41,10 +41,17 @@ Key points: * To avoid splitting the ecosystem, Rust compilers can mix code written for different editions. -[editions]: https://doc.rust-lang.org/edition-guide/ + * Mention that it is quite rare to ever use the compiler directly not through `cargo` (most users never do). - + * It might be worth alluding that Cargo itself is an extremely powerful and comprehensive tool. It is capable of many advanced features including but not limited to: + * Project/package structure + * [workspaces](https://doc.rust*lang.org/cargo/reference/workspaces.html) + * Dev Dependencies and Runtime Dependency management/caching + * [build scripting](https://doc.rust-lang.org/cargo/reference/build-scripts.html) + * [global installation](https://doc.rust-lang.org/cargo/commands/cargo-install.html) + * It is also extensible with sub command plugins as well (such as [cargo clippy](https://github.com/rust-lang/rust-clippy) or [cargo binstall](https://github.com/cargo-bins/cargo-binstall)) + * Read more from the [official Cargo Book](https://doc.rust-lang.org/cargo/) -[^rustc]: Please note, it is quite rare to ever use the compiler directly not through `cargo`. +[editions]: https://doc.rust-lang.org/edition-guide/ -[^cargo]: Cargo itself is a powerful and comprehensive tool capable of many advanced features including but not limited to: Project structure, [workspaces](https://doc.rust*lang.org/cargo/reference/workspaces.html), dev dependencies, [build scripting](https://doc.rust-lang.org/cargo/reference/build-scripts.html), [binary installation](https://doc.rust-lang.org/cargo/commands/cargo-install.html), etc. It is extensible with sub command plugins as well (such as [cargo clippy](https://github.com/rust-lang/rust-clippy) or [cargo binstall](https://github.com/cargo-bins/cargo-binstall)). Read more from the [official Cargo Book](https://doc.rust-lang.org/cargo/) + From 0eec153927b0defe3f3eb3f370e519face9c5e80 Mon Sep 17 00:00:00 2001 From: Brandon Pollack Date: Tue, 10 Jan 2023 22:21:13 +0900 Subject: [PATCH 3/3] move to reference links --- src/cargo/rust-ecosystem.md | 20 +++++++++++++++----- 1 file changed, 15 insertions(+), 5 deletions(-) diff --git a/src/cargo/rust-ecosystem.md b/src/cargo/rust-ecosystem.md index 68f91ba438b2..28a342367ac4 100644 --- a/src/cargo/rust-ecosystem.md +++ b/src/cargo/rust-ecosystem.md @@ -45,13 +45,23 @@ Key points: * It might be worth alluding that Cargo itself is an extremely powerful and comprehensive tool. It is capable of many advanced features including but not limited to: * Project/package structure - * [workspaces](https://doc.rust*lang.org/cargo/reference/workspaces.html) + * [workspaces] * Dev Dependencies and Runtime Dependency management/caching - * [build scripting](https://doc.rust-lang.org/cargo/reference/build-scripts.html) - * [global installation](https://doc.rust-lang.org/cargo/commands/cargo-install.html) - * It is also extensible with sub command plugins as well (such as [cargo clippy](https://github.com/rust-lang/rust-clippy) or [cargo binstall](https://github.com/cargo-bins/cargo-binstall)) - * Read more from the [official Cargo Book](https://doc.rust-lang.org/cargo/) + * [build scripting] + * [global installation] + * It is also extensible with sub command plugins as well (such as [cargo clippy]). + * Read more from the [official Cargo Book] [editions]: https://doc.rust-lang.org/edition-guide/ +[workspaces]: https://doc.rust-lang.org/cargo/reference/workspaces.html + +[build scripting]: https://doc.rust-lang.org/cargo/reference/build-scripts.html + +[global installation]: https://doc.rust-lang.org/cargo/commands/cargo-install.html + +[cargo clippy]: https://github.com/rust-lang/rust-clippy + +[official Cargo Book]: https://doc.rust-lang.org/cargo/ +