From 3f3a42310a54a29a147b771e67e37c0e9772d11d Mon Sep 17 00:00:00 2001 From: "Mr. Beedell, Roke Julian Lockhart (RJLB)" Date: Thu, 8 Jan 2026 15:39:19 +0000 Subject: [PATCH 1/3] Enhance Quickstart with the fundamentals of MozRegression. Added a section explaining the basics of MozRegression, including definitions of 'Good', 'Bad', and 'Broken' outcomes. This should be all that most users need to know, once they have observed the undermentioned video. This remediates https://github.com/mozilla/mozregression/commit/40890ec5b26e330c6ca2778cfd468a6af618993a#r174135351. --- docs/quickstart.md | 22 +++++++++++++++++++--- 1 file changed, 19 insertions(+), 3 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 1938016e2..9ed663eb8 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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 @@ -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 +The command-line version of mozregression is good for power users, or those using Linux, or MacOS X. -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 From 357c04f8e1fc18bfc629b9b2b8a96928dbf840d2 Mon Sep 17 00:00:00 2001 From: "Mr. Beedell, Roke Julian Lockhart (RJLB)" Date: Tue, 10 Feb 2026 14:46:21 +0000 Subject: [PATCH 2/3] =?UTF-8?q?Replace=20=E2=80=9CMacOS=20X=E2=80=9D=20wit?= =?UTF-8?q?h=20=E2=80=9CmacOS=E2=80=9D=20in=20`docs/quickstart.md`.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Remediates https://github.com/mozilla/mozregression/pull/2166#discussion_r2788179975. Co-authored-by: Zeid <2043828+zzzeid@users.noreply.github.com> --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 9ed663eb8..6094a7c60 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -31,7 +31,7 @@ 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. +or macOS. 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 From 3bea88bc0bfcb6e8f70b5d22c78eafa7315bd579 Mon Sep 17 00:00:00 2001 From: "Mr. Beedell, Roke Julian Lockhart (RJLB)" Date: Tue, 10 Feb 2026 15:58:38 +0000 Subject: [PATCH 3/3] =?UTF-8?q?Revert=20=E2=80=9CMozRegression=E2=80=9D=20?= =?UTF-8?q?to=20`mozregression`,=20in=20`docs/quickstart.md`.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Resolves https://github.com/mozilla/mozregression/pull/2166#discussion_r2788176393, due to https://github.com/mozilla/mozregression/pull/2166#discussion_r2788688970. Co-authored-by: Zeid <2043828+zzzeid@users.noreply.github.com> --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 6094a7c60..bf44db1b8 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -7,7 +7,7 @@ main_link: True # The Basics -With MozRegression, you are trying to find the first "bad" build, which refers to where +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