From c7d47fcd6888ec2b14fb84f76e605247d3a930b1 Mon Sep 17 00:00:00 2001 From: Tim van der Meij Date: Tue, 4 Aug 2015 22:04:28 +0200 Subject: [PATCH] Updated Bisecting a Regression (markdown) --- Bisecting-a-Regression.md | 32 +++++++++++++++----------------- 1 file changed, 15 insertions(+), 17 deletions(-) diff --git a/Bisecting-a-Regression.md b/Bisecting-a-Regression.md index c192d2f..cb1921c 100644 --- a/Bisecting-a-Regression.md +++ b/Bisecting-a-Regression.md @@ -1,13 +1,11 @@ -## 1) At a minimum you will need: -- Git -- Node.js +At a minimum you will need Git and Node.js. -## 2) Getting PDF.js -- Start the git command line +## Getting PDF.js +- Start the Git command line - Change to a directory where you want to place PDF.js - Run `git clone git://github.com/mozilla/pdf.js.git` -## 3) Open PDF.js +## Open PDF.js ### Option 1 - Node.js server - Run `cd pdf.js` @@ -17,13 +15,13 @@ ### Option 2 - Another server - Open a browser and go to `http:///pdf.js/web/viewer.html` -## 4) Verify the regression -- Download the bad PDF and open it with the above viewer (using, for example, the Open File button in the toolbar) and verify that the PDF is broken +## Verify the regression +- Download the bad PDF and open it with the above viewer (using, for example, the Open File button in the toolbar) and verify that the PDF is broken. -## 5) Start the bisecting process -- Mark the current version as bad using `git bisect start` and `git bisect bad` +## Start the bisecting process +- Mark the current version as bad using `git bisect start` and `git bisect bad`. -## 6) Find bad commit ID +## Find bad commit ID ### Option 1 - Detecting version / commit of PDF.js installed in Firefox - Open `resource://pdf.js/build/pdf.js` @@ -40,13 +38,13 @@ Aurora: http://mxr.mozilla.org/mozilla-aurora/source/browser/extensions/pdfjs/co Beta: http://mxr.mozilla.org/mozilla-beta/source/browser/extensions/pdfjs/content/build/pdf.js#25 -## 7) Verify the working version +## Verify the working version - `git checkout ` -- Full refresh (CTRL + Shift + R) Firefox and verify that the PDF no longer works -- Mark it as good `git bisect good` +- Full refresh (CTRL + Shift + R) Firefox and verify that the PDF is no longer broken +- Mark it as good with `git bisect good` -## 8) Continue bisecting +## Continue bisecting - Full refresh (CTRL + Shift + R) of the viewer in Firefox - If the current version works, mark it using `git bisect good` -- If it fails, mark it using `git bisect bad` -- Repeat the steps above \ No newline at end of file +- If the current version does not work, mark it using `git bisect bad` +- Repeat the steps above until it converges to a single commit \ No newline at end of file