Marmelator/pdf.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Bisecting a Regression (markdown)

Tim van der Meij 2015-08-04 22:04:28 +02:00
parent b031e583e6
commit c7d47fcd68
1 changed files with 15 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
Bisecting-a-Regression.md

@ -1,13 +1,11 @@
## 1) At a minimum you will need: At a minimum you will need Git and Node.js.
- Git
- Node.js
## 2) Getting PDF.js ## Getting PDF.js
- Start the git command line - Start the Git command line
- Change to a directory where you want to place PDF.js - Change to a directory where you want to place PDF.js
- Run `git clone git://github.com/mozilla/pdf.js.git` - Run `git clone git://github.com/mozilla/pdf.js.git`
## 3) Open PDF.js ## Open PDF.js
### Option 1 - Node.js server ### Option 1 - Node.js server
- Run `cd pdf.js` - Run `cd pdf.js`
@ -17,13 +15,13 @@
### Option 2 - Another server ### Option 2 - Another server
- Open a browser and go to `http://<yourserver>/pdf.js/web/viewer.html` - Open a browser and go to `http://<yourserver>/pdf.js/web/viewer.html`
## 4) Verify the regression ## 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 - 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 ## Start the bisecting process
- Mark the current version as bad using `git bisect start` and `git bisect bad` - 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 ### Option 1 - Detecting version / commit of PDF.js installed in Firefox
- Open `resource://pdf.js/build/pdf.js` - 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 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 <commit ID that you found above>` - `git checkout <commit ID that you found above>`
- Full refresh (CTRL + Shift + R) Firefox and verify that the PDF no longer works - Full refresh (CTRL + Shift + R) Firefox and verify that the PDF is no longer broken
- Mark it as good `git bisect good` - Mark it as good with `git bisect good`
## 8) Continue bisecting ## Continue bisecting
- Full refresh (CTRL + Shift + R) of the viewer in Firefox - Full refresh (CTRL + Shift + R) of the viewer in Firefox
- If the current version works, mark it using `git bisect good` - If the current version works, mark it using `git bisect good`
- If it fails, mark it using `git bisect bad` - If the current version does not work, mark it using `git bisect bad`
- Repeat the steps above - Repeat the steps above until it converges to a single commit