Skip to content

Commit 172766c

Browse files
committed
add Changelog topic to bootstrap/README.md
Signed-off-by: onur-ozkan <work@onurozkan.dev>
1 parent a79ce94 commit 172766c

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

Diff for: src/bootstrap/README.md

+18
Original file line numberDiff line numberDiff line change
@@ -182,9 +182,27 @@ Some general areas that you may be interested in modifying are:
182182
`Config` struct.
183183
* Adding a sanity check? Take a look at `bootstrap/sanity.rs`.
184184

185+
If you make a major change on bootstrap configuration, please remember to:
186+
187+
+ Update `CONFIG_CHANGE_HISTORY` in `src/bootstrap/lib.rs`.
188+
* Update `change-id = {pull-request-id}` in `config.example.toml`.
189+
190+
A 'major change' includes
191+
192+
* A new option or
193+
* A change in the default options.
194+
195+
Changes that do not affect contributors to the compiler or users
196+
building rustc from source don't need an update to `CONFIG_CHANGE_HISTORY`.
197+
185198
If you have any questions, feel free to reach out on the `#t-infra/bootstrap` channel
186199
at [Rust Bootstrap Zulip server][rust-bootstrap-zulip]. When you encounter bugs,
187200
please file issues on the [Rust issue tracker][rust-issue-tracker].
188201

189202
[rust-bootstrap-zulip]: https://rust-lang.zulipchat.com/#narrow/stream/t-infra.2Fbootstrap
190203
[rust-issue-tracker]: https://github.com/rust-lang/rust/issues
204+
205+
## Changelog
206+
207+
Because we do not release bootstrap with versions, we also do not maintain CHANGELOG files. To
208+
review the changes made to bootstrap, simply run `git log --no-merges --oneline -- src/bootstrap`.

0 commit comments

Comments
 (0)