aboutsummaryrefslogtreecommitdiff
path: root/docs/dev
diff options
context:
space:
mode:
authorAleksey Kladov <[email protected]>2021-05-31 15:27:27 +0100
committerAleksey Kladov <[email protected]>2021-05-31 15:27:27 +0100
commit5e577a63734654647e9320dec4a86113b117507a (patch)
tree947a869b26d3a85847517229fabbed39f3476f50 /docs/dev
parentc460baeaf3af69ec4e9a504efa27fbb167e9fecc (diff)
minor: expand docs a tiny bit
Diffstat (limited to 'docs/dev')
-rw-r--r--docs/dev/architecture.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/dev/architecture.md b/docs/dev/architecture.md
index 2624069a5..3de1b99a5 100644
--- a/docs/dev/architecture.md
+++ b/docs/dev/architecture.md
@@ -146,6 +146,8 @@ Reading the docs of the `base_db::input` module should be useful: everything els
146 146
147**Architecture Invariant:** particularities of the build system are *not* the part of the ground state. 147**Architecture Invariant:** particularities of the build system are *not* the part of the ground state.
148In particular, `base_db` knows nothing about cargo. 148In particular, `base_db` knows nothing about cargo.
149For example, `cfg` flags are a part of `base_db`, but `feature`s are not.
150A `foo` feature is a Cargo-level concept, which is lowered by Cargo to `--cfg feature=foo` argument on the command line.
149The `CrateGraph` structure is used to represent the dependencies between the crates abstractly. 151The `CrateGraph` structure is used to represent the dependencies between the crates abstractly.
150 152
151**Architecture Invariant:** `base_db` doesn't know about file system and file paths. 153**Architecture Invariant:** `base_db` doesn't know about file system and file paths.
@@ -452,3 +454,4 @@ It is not cheap enough to enable in prod, and this is a bug which should be fixe
452 454
453rust-analyzer strives to be as configurable as possible while offering reasonable defaults where no configuration exists yet. 455rust-analyzer strives to be as configurable as possible while offering reasonable defaults where no configuration exists yet.
454There will always be features that some people find more annoying than helpful, so giving the users the ability to tweak or disable these is a big part of offering a good user experience. 456There will always be features that some people find more annoying than helpful, so giving the users the ability to tweak or disable these is a big part of offering a good user experience.
457Mind the code--architecture gap: at the moment, we are using fewer feature flags than we really should.