Skip to content

Commit 1652578

Browse files
authored
Merge pull request #2446 from fmease/fix-warning-blocks
Fix some warning blocks that contain Markdown
2 parents a08948f + 6e608e5 commit 1652578

File tree

6 files changed

+15
-1
lines changed

6 files changed

+15
-1
lines changed

src/autodiff/flags.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ LooseTypes // Risk incorrect derivatives instead of aborting when missing Type I
1616
```
1717

1818
<div class="warning">
19+
1920
`LooseTypes` is often helpful to get rid of Enzyme errors stating `Can not deduce type of <X>` and to be able to run some code. But please keep in mind that this flag absolutely has the chance to cause incorrect gradients. Even worse, the gradients might be correct for certain input values, but not for others. So please create issues about such bugs and only use this flag temporarily while you wait for your bug to be fixed.
21+
2022
</div>
2123

2224
### Benchmark flags

src/tests/ci.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -186,9 +186,11 @@ Note that if you start the default try job using `@bors try`, it will skip build
186186
Multiple try builds can execute concurrently across different PRs.
187187
188188
<div class="warning">
189-
bors identify try jobs by commit hash. This means that if you have two PRs
189+
190+
Bors identifies try jobs by commit hash. This means that if you have two PRs
190191
containing the same (latest) commits, running `@bors try` will result in the
191192
*same* try job and it really confuses `bors`. Please refrain from doing so.
193+
192194
</div>
193195
194196
[rustc-perf]: https://github.com/rust-lang/rustc-perf

src/tests/compiletest.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,9 @@ To work around this when working on a particular test, temporarily create a
438438
with these contents:
439439

440440
<div class="warning">
441+
441442
Be careful not to add this `Cargo.toml` or its `Cargo.lock` to your actual PR!
443+
442444
</div>
443445

444446
```toml

src/tests/directives.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -248,11 +248,13 @@ ignoring debuggers.
248248
| `no-prefer-dynamic` | Don't use `-C prefer-dynamic`, don't build as a dylib via a `--crate-type=dylib` preset flag | `ui`, `crashes` | N/A |
249249

250250
<div class="warning">
251+
251252
Tests (outside of `run-make`) that want to use incremental tests not in the
252253
incremental test-suite must not pass `-C incremental` via `compile-flags`, and
253254
must instead use the `//@ incremental` directive.
254255

255256
Consider writing the test as a proper incremental test instead.
257+
256258
</div>
257259

258260
### Rustdoc

src/tests/minicore.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ ui/codegen/assembly test suites. It provides `core` stubs for tests that need to
77
build for cross-compiled targets but do not need/want to run.
88

99
<div class="warning">
10+
1011
Please note that [`minicore`] is only intended for `core` items, and explicitly
1112
**not** `std` or `alloc` items because `core` items are applicable to a wider
1213
range of tests.
14+
1315
</div>
1416

1517
A test can use [`minicore`] by specifying the `//@ add-core-stubs` directive.

src/tests/running.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ development because it takes a really long time. For local development, see the
88
subsection after on how to run a subset of tests.
99

1010
<div class="warning">
11+
1112
Running plain `./x test` will build the stage 1 compiler and then run the whole
1213
test suite. This not only include `tests/`, but also `library/`, `compiler/`,
1314
`src/tools/` package tests and more.
@@ -16,6 +17,7 @@ You usually only want to run a subset of the test suites (or even a smaller set
1617
of tests than that) which you expect will exercise your changes. PR CI exercises
1718
a subset of test collections, and merge queue CI will exercise all of the test
1819
collection.
20+
1921
</div>
2022

2123
```text
@@ -116,8 +118,10 @@ By listing which test suites you want to run,
116118
you avoid having to run tests for components you did not change at all.
117119

118120
<div class="warning">
121+
119122
Note that bors only runs the tests with the full stage 2 build; therefore, while
120123
the tests **usually** work fine with stage 1, there are some limitations.
124+
121125
</div>
122126

123127
### Run all tests using a stage 2 compiler

0 commit comments

Comments
 (0)