You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tools/unstable-api/README.md
+9-2Lines changed: 9 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ This tool will dump the public API for an unstable feature.
7
7
From this directory, run something like:
8
8
9
9
```shell
10
-
cargo run --release -- --feature $feature --repo-root $path_to_rust| rustfmt
10
+
cargo run --release -- --feature $feature --repo-root $path_to_rust
11
11
```
12
12
13
13
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:
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
+
22
29
## Limitations
23
30
24
31
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