Skip to content

Commit

Permalink
remove ctag section
Browse files Browse the repository at this point in the history
  • Loading branch information
andoriyu authored and jyn514 committed Sep 8, 2021
1 parent 8f98dac commit 295922e
Showing 1 changed file with 0 additions and 27 deletions.
27 changes: 0 additions & 27 deletions src/building/suggested.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,33 +71,6 @@ Task] instead:

[Build Task]: https://code.visualstudio.com/docs/editor/tasks

## Configuring `ctags`

One of the challenges with rustc is that the RLS can't handle it, since it's a
bootstrapping compiler. This makes code navigation difficult. One solution is to
use `ctags`.

`ctags` has a long history and several variants. Exuberant Ctags seems to be
quite commonly distributed but it does not have out-of-box Rust support. Some
distributions seem to use [Universal Ctags][utags], which is a maintained fork
and does have built-in Rust support.

The following script can be used to set up Exuberant Ctags:
[https://github.com/nikomatsakis/rust-etags][etags].

`ctags` integrates into emacs and vim quite easily. The following can then be
used to build and generate tags:

```console
$ rust-ctags src/lib* && ./x.py build <something>
```

This allows you to do "jump-to-def" with whatever functions were around when
you last built, which is ridiculously useful.

[etags]: https://github.com/nikomatsakis/rust-etags
[utags]: https://github.com/universal-ctags/ctags

## Check, check, and check again

When doing simple refactorings, it can be useful to run `./x.py check`
Expand Down

0 comments on commit 295922e

Please sign in to comment.