CONTRIBUTING: Document the backtrack limit
@@ -64,7 +64,7 @@ Modified: CONTRIBUTING.md
This can be handy when you are testing development versions on your PC
and cannot remember exactly which version you had installed, or if you have given
a development copy (or instruction to build such) to a user, and wish to have them
-confirm *exactly* what they are using.
+confirm _exactly_ what they are using.
Finally, we tell `git-testament` that we trust the `stable` branch to carry
releases. If the build is being performed when not on the `stable` branch, and
@@ -107,10 +107,10 @@ Rustup is distributed. The steps for a release are:
anything egregious in which case abort the change and roll back.
8. Once the official release has happened, prepare and push a tag
of that commit, and also push the content to master
- * `git tag -as $VER_NUM -m $VER_NUM` (optionally without -s if not GPG
+ - `git tag -as $VER_NUM -m $VER_NUM` (optionally without -s if not GPG
signing the tag)
- * `git push origin HEAD:master`
- * `git push origin $VER_NUM`
+ - `git push origin HEAD:master`
+ - `git push origin $VER_NUM`
## Developer tips and tricks
@@ -125,6 +125,17 @@ run.
$ RUSTUP_FORCE_ARG0=rustup cargo run -- uninstall nightly
```
+### `RUSTUP_BACKTRACK_LIMIT`
+
+If it's necessary to alter the backtracking limit from the default of half
+a release cycle for some reason, you can set the `RUSTUP_BACKTRACK_LIMIT`
+environment variable. If this is unparseable as an `i32` or if it's absent
+then the default of 21 days (half a cycle) is used. If it parses and is less
+than 1, it is clamped to 1 at minimum.
+
+This is not meant for use by users, but can be suggested in diagnosing an issue
+should one arise with the backtrack limits.
+
### `RUSTUP_BACKTRACE`
By default while running tests, we unset some environment variables that will
