Skip to content

Commit e696a60

Browse files
committed
Update README.
1 parent 2011561 commit e696a60

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

tools/unstable-api/README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This tool will dump the public API for an unstable feature.
77
From this directory, run something like:
88

99
```shell
10-
cargo run --release -- --feature $feature --repo-root $path_to_rust | rustfmt
10+
cargo run --release -- --feature $feature --repo-root $path_to_rust
1111
```
1212

1313
where `$feature` is the name of the unstable feature and `$path_to_rust` is the path to a local clone of `rust-lang/rust`. You'll probably need to run `x.py` first to make sure submodules are cloned.
@@ -16,9 +16,16 @@ You can also install it as a Cargo tool and use it that way:
1616

1717
```shell
1818
cargo install --path .
19-
cargo unstable-api --feature $feature --repo-root $path_to_rust | rustfmt
19+
cd $path_to_rust
20+
cargo unstable-api --feature $feature
2021
```
2122

23+
You can leave out the `--repo-root` option when running it inside the `rust-lang/rust` repository.
24+
25+
## Output formatting
26+
27+
On Unix, the output is automatically formatted with `rustfmt` and highlighted with `bat`, if you have those tools installed.
28+
2229
## Limitations
2330

2431
APIs that are generated by macros won't be picked up. This tool just parses the source code so it can be run without needing to build the standard library itself.

0 commit comments

Comments
 (0)