Update RUSTUP_UNPACK_RAM docs to reflect code #2486
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Match the minimum to `MAX_FILE_SIZE`'s value in `src/dist/component/package.rs` Also attempt to describe the default behavior
|
I'm not sure if the explanation of the default behavior is sufficient or desired, and since it's not a static number, it's difficult to explain it succinctly. 🤔 |
nashley
commented
Sep 12, 2020
doc/src/environment-variables.md
Outdated
| @@ -28,7 +28,7 @@ | |||
| determines the directory that traces will be written too. Traces are of the | |||
| form PID.trace. Traces can be read by the Catapult project [tracing viewer]. | |||
|
|
|||
| - `RUSTUP_UNPACK_RAM` *unstable* (default 400M, min 100M) Caps the amount of | |||
| - `RUSTUP_UNPACK_RAM` *unstable* (default auto or 500M if on a platform such as FreeBSD or NetBSD, min 210M) Caps the amount of | |||
There was a problem hiding this comment.
I specified 210M since 220000000/1024^2=209.80835 and the previous documentation seemed to refer to M as a unit of mebibytes instead of megabytes, but perhaps it'd be better to refer to the more human-friendly megabytes instead.
There was a problem hiding this comment.
I think I'll change this to explicitly MB instead of using the ambiguous M to refer to MiB
kinnison
approved these changes
Sep 15, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Match the minimum to
MAX_FILE_SIZE's value insrc/dist/component/package.rsAlso attempt to describe the default behavior