diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/dev/README.md | 8 | ||||
-rw-r--r-- | docs/dev/style.md | 10 | ||||
-rw-r--r-- | docs/user/generated_config.adoc | 6 |
3 files changed, 21 insertions, 3 deletions
diff --git a/docs/dev/README.md b/docs/dev/README.md index 9c0eb1358..f74f7d8eb 100644 --- a/docs/dev/README.md +++ b/docs/dev/README.md | |||
@@ -235,12 +235,14 @@ We don't do "patch" releases, unless something truly egregious comes up. | |||
235 | 235 | ||
236 | There are three sets of people with extra permissions: | 236 | There are three sets of people with extra permissions: |
237 | 237 | ||
238 | * rust-analyzer GitHub organization **admins** (which include current t-compiler leads). | 238 | * rust-analyzer GitHub organization (**admins**)[https://github.com/orgs/rust-analyzer/people?query=role:owner] (which include current t-compiler leads). |
239 | Admins have full access to the org. | 239 | Admins have full access to the org. |
240 | * **review** team in the organization. | 240 | * (**review**)[https://github.com/orgs/rust-analyzer/teams/review] team in the organization. |
241 | Reviewers have `r+` access to all of organization's repositories and publish rights on crates.io. | 241 | Reviewers have `r+` access to all of organization's repositories and publish rights on crates.io. |
242 | They also have direct commit access, but all changes should via bors queue. | 242 | They also have direct commit access, but all changes should via bors queue. |
243 | It's ok to self-approve if you think you know what you are doing! | 243 | It's ok to self-approve if you think you know what you are doing! |
244 | bors should automatically sync the permissions. | 244 | bors should automatically sync the permissions. |
245 | * **triage** team in the organization. | 245 | * (**triage**)[https://github.com/orgs/rust-analyzer/teams/triage] team in the organization. |
246 | This team can label and close issues. | 246 | This team can label and close issues. |
247 | |||
248 | Note that at the time being you need to be a member of the org yourself to view the links. | ||
diff --git a/docs/dev/style.md b/docs/dev/style.md index 468dedff2..7c47c26b2 100644 --- a/docs/dev/style.md +++ b/docs/dev/style.md | |||
@@ -152,6 +152,16 @@ Do not reuse marks between several tests. | |||
152 | 152 | ||
153 | **Rationale:** marks provide an easy way to find the canonical test for each bit of code. | 153 | **Rationale:** marks provide an easy way to find the canonical test for each bit of code. |
154 | This makes it much easier to understand. | 154 | This makes it much easier to understand. |
155 | More than one mark per test / code branch doesn't add significantly to understanding. | ||
156 | |||
157 | ## `#[should_panic]` | ||
158 | |||
159 | Do not use `#[should_panic]` tests. | ||
160 | Instead, explicitly check for `None`, `Err`, etc. | ||
161 | |||
162 | **Rationale:**a `#[should_panic]` is a tool for library authors, to makes sure that API does not fail silently, when misused. | ||
163 | `rust-analyzer` is not a library, we don't need to test for API misuse, and we have to handle any user input without panics. | ||
164 | Panic messages in the logs from the `#[should_panic]` tests are confusing. | ||
155 | 165 | ||
156 | ## Function Preconditions | 166 | ## Function Preconditions |
157 | 167 | ||
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc index 871c65add..e0ee35b4e 100644 --- a/docs/user/generated_config.adoc +++ b/docs/user/generated_config.adoc | |||
@@ -39,6 +39,12 @@ List of features to activate. | |||
39 | -- | 39 | -- |
40 | Run build scripts (`build.rs`) for more precise code analysis. | 40 | Run build scripts (`build.rs`) for more precise code analysis. |
41 | -- | 41 | -- |
42 | [[rust-analyzer.cargo.useRustcWrapperForBuildScripts]]rust-analyzer.cargo.useRustcWrapperForBuildScripts (default: `true`):: | ||
43 | + | ||
44 | -- | ||
45 | Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to | ||
46 | avoid compiling unnecessary things. | ||
47 | -- | ||
42 | [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: | 48 | [[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`):: |
43 | + | 49 | + |
44 | -- | 50 | -- |