Skip to content

docs: Enhance Quickstart with the fundamentals of mozregression #2166

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RokeJulianLockhart wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: Enhance Quickstart with the fundamentals of mozregression #2166

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3f3a423
Enhance Quickstart with the fundamentals of MozRegression.
RokeJulianLockhart Jan 8, 2026
357c04f
Replace “MacOS X” with “macOS” in `docs/quickstart.md`.
RokeJulianLockhart Feb 10, 2026
3bea88b
Revert “MozRegression” to `mozregression`, in `docs/quickstart.md`.
RokeJulianLockhart Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 20 additions & 4 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,22 @@ order: 10
main_link: True
---

# The Basics

With mozregression, you are trying to find the first "bad" build, which refers to where
the regression first appears.

When provided with the option to determine the outcome of each test (that you conduct per
build):

- "Good" means that the test passed (the build works).

- "Bad" means that the test failed, so it exhibits the regression.

- "Broken" means that that build could not be tested, maybe because it doesn't run at all,
or fails for an unrelated reason. That option allows you evaluate another build that is
nearby (so-to-speak), without changing the bisect range.

# GUI

The easiest way to use mozregression (at least on Windows) is via the GUI. This
Expand All @@ -14,11 +30,11 @@ youtube video by Pascal Chevrel describes how to install and use it:

# Command line

The command-line version of mozregression is good for power users or those using Linux
or MacOS X.
The command-line version of mozregression is good for power users, or those using Linux,
or macOS.

Let's say you just found a bug in the current nightly build and you know that
bug didn't exist in the nightly from a few weeks ago. You want to find the
Let's say that you just found a bug in the current nightly build, and you know that
that bug didn't exist in the nightly from a few weeks ago. You want to find the
regression range of this bug (the window of commits the bug was introduced in).

To find the range run the mozregression command on the command-line and give
Expand Down
Loading