@@ -20,7 +20,7 @@ affecting any existing installation. Remember to keep those two environment vari
20
20
set when running your compiled ` rustup-init ` or the toolchains it installs, but _ unset_
21
21
when rebuilding ` rustup ` itself.
22
22
23
- We use ` rustfmt ` to keep our codebase consistently formatted. Please ensure that
23
+ We use ` rustfmt ` to keep our codebase consistently formatted. Please ensure that
24
24
you have correctly formatted your code (most editors will do this automatically
25
25
when saving) or it may not pass the CI tests.
26
26
@@ -46,11 +46,11 @@ The first part is always the binary name as per `clap`'s normal operation. The
46
46
version number is a combination of the most recent tag in the git repo, and the
47
47
number of commits since that tag. The parenthesised information is, naturally,
48
48
the SHA of the most recent commit and the date of that commit. If the indication
49
- of a dirty tree is present, the number of changes is indicated. This combines
49
+ of a dirty tree is present, the number of changes is indicated. This combines
50
50
adds, deletes, modifies, and unknown entries.
51
51
52
52
You can request further information of a ` rustup ` binary with the
53
- ` rustup dump-testament ` hidden command. It produces output of the form:
53
+ ` rustup dump-testament ` hidden command. It produces output of the form:
54
54
55
55
``` shell
56
56
$ rustup dump-testament
@@ -64,25 +64,25 @@ Modified: CONTRIBUTING.md
64
64
This can be handy when you are testing development versions on your PC
65
65
and cannot remember exactly which version you had installed, or if you have given
66
66
a development copy (or instruction to build such) to a user, and wish to have them
67
- confirm * exactly * what they are using.
67
+ confirm _ exactly _ what they are using.
68
68
69
69
Finally, we tell ` git-testament ` that we trust the ` stable ` branch to carry
70
- releases. If the build is being performed when not on the ` stable ` branch, and
70
+ releases. If the build is being performed when not on the ` stable ` branch, and
71
71
the tag and ` CARGO_PKG_VERSION ` differ, then the short version string will include
72
72
both, in the form ` rustup-init 1.18.3 :: 1.18.2+99 (a54051502 2019-05-26) ` which
73
73
indicates the crate version before the rest of the commit.
74
74
On the other hand, if the build was on the ` stable ` branch then regardless
75
75
of the tag information, providing the commit was clean, the version is
76
- always replaced by the crate version. The ` dump-testament ` hidden command can
76
+ always replaced by the crate version. The ` dump-testament ` hidden command can
77
77
reveal the truth however.
78
78
79
79
## Making a release
80
80
81
81
Before making a release, ensure that ` rustup-init.sh ` is behaving correctly,
82
82
and that you're satisfied that nothing in the ecosystem is breaking because
83
- of the update. A useful set of things to check includes verifying that
83
+ of the update. A useful set of things to check includes verifying that
84
84
real-world toolchains install okay, and that ` rls-vscode ` isn't broken by
85
- the release. While it's not our responsibility if they depend on non-stable
85
+ the release. While it's not our responsibility if they depend on non-stable
86
86
APIs, we should behave well if we can.
87
87
88
88
Producing the final release artifacts is a bit involved because of the way
@@ -107,10 +107,10 @@ Rustup is distributed. The steps for a release are:
107
107
anything egregious in which case abort the change and roll back.
108
108
8 . Once the official release has happened, prepare and push a tag
109
109
of that commit, and also push the content to master
110
- * ` git tag -as $VER_NUM -m $VER_NUM ` (optionally without -s if not GPG
110
+ - ` git tag -as $VER_NUM -m $VER_NUM ` (optionally without -s if not GPG
111
111
signing the tag)
112
- * ` git push origin HEAD:master `
113
- * ` git push origin $VER_NUM `
112
+ - ` git push origin HEAD:master `
113
+ - ` git push origin $VER_NUM `
114
114
115
115
## Developer tips and tricks
116
116
@@ -125,6 +125,17 @@ run.
125
125
$ RUSTUP_FORCE_ARG0=rustup cargo run -- uninstall nightly
126
126
```
127
127
128
+ ### ` RUSTUP_BACKTRACK_LIMIT `
129
+
130
+ If it's necessary to alter the backtracking limit from the default of half
131
+ a release cycle for some reason, you can set the ` RUSTUP_BACKTRACK_LIMIT `
132
+ environment variable. If this is unparseable as an ` i32 ` or if it's absent
133
+ then the default of 21 days (half a cycle) is used. If it parses and is less
134
+ than 1, it is clamped to 1 at minimum.
135
+
136
+ This is not meant for use by users, but can be suggested in diagnosing an issue
137
+ should one arise with the backtrack limits.
138
+
128
139
### ` RUSTUP_BACKTRACE `
129
140
130
141
By default while running tests, we unset some environment variables that will
0 commit comments