mirror of
https://github.com/rust-lang/rust-analyzer.git
synced 2025-08-31 07:37:30 +00:00
Add more docs
This commit is contained in:
parent
e6776c3e1b
commit
188b0f96f9
20 changed files with 72 additions and 40 deletions
|
@ -1,4 +1,19 @@
|
|||
//! FIXME: write short doc here
|
||||
//! In rust-analyzer, we maintain a strict separation between pure abstract
|
||||
//! semantic project model and a concrete model of a particular build system.
|
||||
//!
|
||||
//! Pure model is represented by the [`base_db::CrateGraph`] from another crate.
|
||||
//!
|
||||
//! In this crate, we are conserned with "real world" project models.
|
||||
//!
|
||||
//! Specifically, here we have a representation for a Cargo project
|
||||
//! ([`CargoWorkspace`]) and for manually specified layout ([`ProjectJson`]).
|
||||
//!
|
||||
//! Roughly, the things we do here are:
|
||||
//!
|
||||
//! * Project discovery (where's the relevant Cargo.toml for the current dir).
|
||||
//! * Custom build steps (`build.rs` code generation and compilation of
|
||||
//! procedural macros).
|
||||
//! * Lowering of concrete model to a [`base_db::CrateGraph`]
|
||||
|
||||
mod cargo_workspace;
|
||||
mod cfg_flag;
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue