Skip to content

Added mention of universal ctags #314

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 1 commit into from
May 3, 2019
Merged

Added mention of universal ctags #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions src/how-to-build-and-run.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -300,11 +300,19 @@ in other sections:

### 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`. The following
script can be used to set it up: [https://github.com/nikomatsakis/rust-etags][etags].
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 integrates into emacs and vim quite easily. The following can then be
`ctags` has a long history and several variants. Exhuberant 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 Exhuberant 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
Expand All @@ -315,6 +323,7 @@ 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

### Cleaning out build directories

Expand Down