Skip to content

Commit 29dd736

Browse files
authored
Add "Updating tools" section to toolstate chapter (#499)
1 parent caf581c commit 29dd736

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

src/infra/toolstate.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,17 @@ break.
5050
For further details, see the comments in the involved files: [`checktools.sh`],
5151
[`publish_toolstate.py`] as well as the other files mentioned there.
5252

53+
## Updating tools
54+
55+
Tools can be updated by updating the submodule to the proper commit.
56+
57+
Run `git submodule update --remote path/to/submodule`, add the updates, make
58+
sure the tests pass, commit, and send a pull request. The path is from the
59+
root of the rust repository, so for example, the reference is
60+
`src/doc/reference` and rustfmt is `src/tools/rustfmt`.
61+
62+
While not required, [subup] may assist you with this.
63+
5364
## Adding a tool
5465

5566
To add a new tool to be tracked, the following steps must be taken:
@@ -77,6 +88,7 @@ To add a new tool to be tracked, the following steps must be taken:
7788
[`latest.json`]: https://github.com/rust-lang-nursery/rust-toolstate/blob/master/_data/latest.json
7889
[Book]: https://doc.rust-lang.org/book/
7990
[Reference]: https://doc.rust-lang.org/reference/
91+
[subup]: https://github.com/ehuss/subup
8092
[toolstate]: https://rust-lang-nursery.github.io/rust-toolstate/
8193
[toolstate repository]: https://github.com/rust-lang-nursery/rust-toolstate/
8294
[forge]: ../index.html

0 commit comments

Comments
 (0)