Skip to content

Commit

Permalink
note that -Z save-analysis was removed and this is currently broken
Browse files Browse the repository at this point in the history
  • Loading branch information
wfraser authored Nov 23, 2023
1 parent 4da3053 commit 8238c71
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ Browse Rust code from the compiler's perspective.

rsbrowse runs `rustc` on your code and tells it to save analysis info about what it sees. It then presents it in an interactive text-mode viewer. The analysis info is the same thing that powers RLS (Rust Language Server) for enhancing IDEs, but instead of using it to navigate source code, rsbrowse does the reverse and lets you browse the structure of the program from the compiler's view.

# ⚠️ *currently broken* ⚠️

This project depends on the `-Z save-analysis` flag of rustc, which was removed in Rust 1.69.

I have plans to migrate it to the Rustdoc JSON output, but haven't implemented that yet.

# Requirements

* cargo
Expand All @@ -33,4 +39,4 @@ To exit, press ESC to activate the menu bar, and right arrow to select Quit.

rsbrowse is still pretty new and may have bugs. Unfortunately, as a curses application, panic text written to stderr gets lost. To capture it, redirect it, like `rsbrowse <path> 2>err.log` and try and reproduce what you did. (Also set `RUST_BACKTRACE=1` while you're at it.) Then please file an issue :)

To see a list of TODOs and ideas for future enhancements, see [`TODO.md`](TODO.md). Note that rust-analysis output is somewhat limited in what it gives us, so some things may be harder to implement than they seem.
To see a list of TODOs and ideas for future enhancements, see [`TODO.md`](TODO.md). Note that rust-analysis output is somewhat limited in what it gives us, so some things may be harder to implement than they seem.

0 comments on commit 8238c71

Please sign in to comment.