diff --git a/docs/quickstart.md b/docs/quickstart.md index 1938016e2..bf44db1b8 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 -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