Skip to content

Commit

Permalink
feat: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
georglauterbach authored Nov 8, 2024
1 parent 9ec4e4b commit 62e79ac
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions src/rust/NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ This Development Container Feature installs [Rust](https://www.rust-lang.org/) v
| `CARGO_TARGET_DIR` | Directory that Cargo uses to place binaries & build artifacts | `${containerWorkspaceFolder}/target` | No |
| `PATH` | Extend `PATH` to include `rustup`, `cargo`, `rustc`, etc. | `/usr/rust/cargo/home/bin:${PATH}` | No |

> [!Important]
> [!IMPORTANT]
>
> You may need to overwrite the environment variables marked with "Yes" in the "Needs Overwrite" column. The new values should be locations that are persisted across container restarts. You most likely want to overwrite these variables when you work with different toolchains at the same time and having them side-by-side is desired.
>
> You can define these variables in `containerEnv` in your `devcontainer.json` file. Good defaults are: `RUSTUP_HOME: "${containerWorkspaceFolder}/.rust/rustup_home"` and `"CARGO_HOME": "${containerWorkspaceFolder}/.rust/cargo_home"`.
> You should define these variables in `containerEnv` and additionally in `remoteEnv` in your `devcontainer.json` file. Good defaults are: `RUSTUP_HOME: "${containerWorkspaceFolder}/.rust/rustup_home"` and `"CARGO_HOME": "${containerWorkspaceFolder}/.rust/cargo_home"`.
> [!NOTE]
>
Expand Down
2 changes: 1 addition & 1 deletion src/rust/devcontainer-feature.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// ref: https://github.com/devcontainers/spec/blob/main/schemas/devContainerFeature.schema.json
{
"id": "rust",
"version": "5.2.0",
"version": "5.2.1",
"name": "Development Container Feature - Rust",
"documentationURL": "https://github.com/georglauterbach/dev-container-features/tree/main/src/rust",
"description": "A Development Container Feature to work efficiently and effortlessly with the Rust programming language",
Expand Down

0 comments on commit 62e79ac

Please sign in to comment.