Skip to content

Commit 27c7fef

Browse files
committed
contributing: clarify wording; avoid "green" jargon and restore tests/intro.md link
1 parent 79fb160 commit 27c7fef

File tree

8 files changed

+15
-13
lines changed

8 files changed

+15
-13
lines changed

rust-version

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
425a9c0a0e365c0b8c6cfd00c2ded83a73bed9a0
1+
a1dbb443527bd126452875eb5d5860c1d001d761

src/autodiff/internals.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ fn main() {
1717

1818
The detailed documentation for the `std::autodiff` module is available at [std::autodiff](https://doc.rust-lang.org/std/autodiff/index.html).
1919

20-
Differentiable programing is used in various fields like numerical computing, [solid mechanics][ratel], [computational chemistry][molpipx], [fluid dynamics][waterlily] or for Neural Network training via Backpropagation, [ODE solver][diffsol], [differentiable rendering][libigl], [quantum computing][catalyst], and climate simulations.
20+
Differentiable programming is used in various fields like numerical computing, [solid mechanics][ratel], [computational chemistry][molpipx], [fluid dynamics][waterlily] or for Neural Network training via Backpropagation, [ODE solver][diffsol], [differentiable rendering][libigl], [quantum computing][catalyst], and climate simulations.
2121

2222
[ratel]: https://gitlab.com/micromorph/ratel
2323
[molpipx]: https://arxiv.org/abs/2411.17011v

src/building/bootstrapping/debugging-bootstrap.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,11 @@ There are two orthogonal ways to control which kind of tracing logs you want:
8181
- If you select a level, all events/spans with an equal or higher priority level will be shown.
8282
2. You can also control the log **target**, e.g. `bootstrap` or `bootstrap::core::config` or a custom target like `CONFIG_HANDLING` or `STEP`.
8383
- Custom targets are used to limit what kinds of spans you are interested in, as the `BOOTSTRAP_TRACING=trace` output can be quite verbose. Currently, you can use the following custom targets:
84-
- `CONFIG_HANDLING`: show spans related to config handling
85-
- `STEP`: show all executed steps. Note that executed commands have `info` event level.
86-
- `COMMAND`: show all executed commands. Note that executed commands have `trace` event level.
84+
- `CONFIG_HANDLING`: show spans related to config handling.
85+
- `STEP`: show all executed steps. Executed commands have `info` event level.
86+
- `COMMAND`: show all executed commands. Executed commands have `trace` event level.
87+
- `IO`: show performed I/O operations. Executed commands have `trace` event level.
88+
- Note that many I/O are currently not being traced.
8789

8890
You can of course combine them (custom target logs are typically gated behind `TRACE` log level additionally):
8991

src/contributing.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -154,13 +154,11 @@ The CI in rust-lang/rust applies your patches directly against the current maste
154154
not against the commit your branch is based on. This can lead to unexpected failures
155155
if your branch is outdated, even when there are no explicit merge conflicts.
156156

157-
Before submitting or updating a PR, make sure to update your branch
158-
as mentioned [here](git.md#keeping-things-up-to-date) if it's significantly
159-
behind the master branch (e.g., more than 100 commits behind).
160-
This fetches the latest master branch and rebases your changes on top of it,
161-
ensuring your PR is tested against the latest code.
157+
Update your branch only when needed: when you have merge conflicts, upstream CI is broken and blocking your green PR, or a maintainer requests it. Avoid updating an already-green PR under review unless necessary. During review, make incremental commits to address feedback. Prefer to squash or rebase at the end, and do so when a reviewer requests it.
162158

163-
After rebasing, it's recommended to [run the relevant tests locally](tests/intro.md) to catch any issues before CI runs.
159+
When updating, use `git push --force-with-lease` and leave a brief comment explaining what changed. Some repos prefer merging from `upstream/master` instead of rebasing; follow the project's conventions. See [keeping things up to date](git.md#keeping-things-up-to-date) for detailed instructions.
160+
161+
After updating, run local checks (e.g., `mdbook build` for this repo) to catch issues before CI runs.
164162

165163
### r?
166164

src/sanitizers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ implementation:
4545
[marked][sanitizer-attribute] with appropriate LLVM attribute:
4646
`SanitizeAddress`, `SanitizeHWAddress`, `SanitizeMemory`, or
4747
`SanitizeThread`. By default all functions are instrumented, but this
48-
behaviour can be changed with `#[no_sanitize(...)]`.
48+
behaviour can be changed with `#[sanitize(xyz = "on|off")]`.
4949

5050
* The decision whether to perform instrumentation or not is possible only at a
5151
function granularity. In the cases were those decision differ between

src/solve/candidate-preference.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ fn overflow<T: Trait>() {
9595
```
9696

9797
This preference causes a lot of issues. See [#24066]. Most of the
98-
issues are caused by prefering where-bounds over impls even if the where-bound guides type inference:
98+
issues are caused by preferring where-bounds over impls even if the where-bound guides type inference:
9999
```rust
100100
trait Trait<T> {
101101
fn call_me(&self, x: T) {}

src/tests/directives.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ for more details.
111111
| `forbid-output` | A pattern which must not appear in stderr/`cfail` output | `ui`, `incremental` | Regex pattern |
112112
| `run-flags` | Flags passed to the test executable | `ui` | Arbitrary flags |
113113
| `known-bug` | No error annotation needed due to known bug | `ui`, `crashes`, `incremental` | Issue number `#123456` |
114+
| `compare-output-by-lines` | Compare the output by lines, rather than as a single string | All | N/A |
114115

115116
[^check_stdout]: presently <!-- date-check: Oct 2024 --> this has a weird quirk
116117
where the test binary's stdout and stderr gets concatenated and then

src/tests/ui.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ will check for output files:
9595
[Normalization](#normalization)).
9696
- `dont-check-compiler-stderr` — Ignores stderr from the compiler.
9797
- `dont-check-compiler-stdout` — Ignores stdout from the compiler.
98+
- `compare-output-by-lines` — Some tests have non-deterministic orders of output, so we need to compare by lines.
9899

99100
UI tests run with `-Zdeduplicate-diagnostics=no` flag which disables rustc's
100101
built-in diagnostic deduplication mechanism. This means you may see some

0 commit comments

Comments
 (0)