Skip to content

Commit 5c81b57

Browse files
authored
Merge pull request #387 from VorpalBlade/feature/better_tutorial_docs
Improve tutorial for new users
2 parents c1482b1 + 2c40d22 commit 5c81b57

File tree

2 files changed

+8
-2
lines changed

2 files changed

+8
-2
lines changed

guide/src/boundaries.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ cargo bisect-rustc --start=2018-08-14 --end=2018-10-11
2929

3030
If the nightly with the regression was within the past 167 days, then it will automatically start bisecting the individual PRs merged on that day using [Git commit boundaries](#git-commit-boundaries).
3131

32+
> **Note**: A pitfall is that if you use something like `rustc +nightly --version` to figure out the version you are on it will often identify a date that is one day early from the nightly toolchain version. E.g. `nightly-2025-07-19` will say `2025-07-18`, since that is when the most recent commit was merged, even though the toolchain was published on the 19th.
33+
3234
## Git commit boundaries
3335

3436
You can pass the particular git commit hash of a PR as a boundary.

guide/src/tutorial.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,10 +49,14 @@ It will do a binary search between the start and end range to find exactly where
4949
5050
[`--regress`]: usage.md#regression-check
5151

52-
In our example, in just a few steps, we can we find that it stopped working on `nightly-2018-07-30`.
52+
> **Note**: Additional ways to specify boundaries include stable versions and git commit hashes. See the [Bisection boundaries] chapter for more details on setting these options.
53+
54+
[Bisection boundaries]: boundaries.md
55+
56+
In our example, in just a few steps, we can find that it stopped working on `nightly-2018-07-30`.
5357

5458
If the regression is recent enough, then it will print out a list of PRs that were committed on that date.
55-
In this particular example, it is too old, so we'll need to manually inspect the git log to see which PR's were merged.
59+
In this particular example, it is too old, so we'll need to manually inspect the git log to see which PRs were merged.
5660

5761
If the nightly was within the last 167 days, then `cargo-bisect-rustc` will then start bisecting those individual PRs.
5862

0 commit comments

Comments
 (0)