Skip to content

Add a note about building rust-analyzer-proc-macro-srv #1467

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 19, 2022
Merged

Add a note about building rust-analyzer-proc-macro-srv #1467

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e1ff81
Add a note about building `rust-analyzer-proc-macro-srv`
WaffleLapkin Sep 16, 2022
3cdfa24
Don't use shorthands in command examples
WaffleLapkin Sep 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/building/how-to-build-and-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,6 +221,15 @@ fall back to using `cargo` from the installed `nightly`, `beta`, or `stable` too
`rustup install nightly` if you haven't already. See the
[rustup documentation on custom toolchains](https://rust-lang.github.io/rustup/concepts/toolchains.html#custom-toolchains).

**Note:** rust-analyzer and IntelliJ Rust plugin use a component called
`rust-analyzer-proc-macro-srv` to work with proc macros. If you intend to use a
custom toolchain for a project (e.g. via `rustup override set stage1`) you may
want to build this component:

```bash
x b proc-macro-srv-cli
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We generally prefer to use ./x.py on the guide, also using a shorthand command may confuse new contributors.

Copy link
Member Author

@WaffleLapkin WaffleLapkin Sep 18, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right! This makes perfect sense, I'm just so used to the shorthand commands and x that I forgot about it 😅

```

## Building targets for cross-compilation

To produce a compiler that can cross-compile for other targets,
Expand Down