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

Removing Aurora information and minor textual improvements

Tim van der Meij 2017-04-23 16:46:57 +02:00
parent ae634a887e
commit 4d049b5d5d
1 changed files with 31 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

66
Bisecting-a-Regression.md

@ -1,50 +1,46 @@
At a minimum you will need Git and Node.js. The minimum requirements are Git and Node.js.
## Getting PDF.js ## Clone PDF.js
- Start the Git command line - Open 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`.
## Open PDF.js ## Start PDF.js
### Option 1 - Node.js server ### Using Node.js
- Run `cd pdf.js` - Run `cd pdf.js`.
- Run `gulp server` - Run `gulp server`.
- Open a browser and go to `http://localhost:8080/web/viewer.html` - Open a browser and visit `http://localhost:8080/web/viewer.html`.
### Option 2 - Another server ### Using 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`.
## 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 rendering the PDF is broken.
## Start the bisecting process ## Start the bisection 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`.
## Find bad commit ID ## Find the bad commit ID
### Option 1 - Detecting version / commit of PDF.js installed in Firefox ### Using the commit/version of PDF.js installed in Firefox
- Open `resource://pdf.js/build/pdf.js` - Open `resource://pdf.js/build/pdf.js`.
- Find the commit in the line with 'PDFJS.build = ' - Find the commit in the line with `PDFJS.build =`.
- Find the version in the line with 'PDFJS.version = ' - Find the version in the line with `PDFJS.version =`.
### Option 2 - Using Bugzilla patch ### Using a Bugzilla patch
- A Bugzilla patch contains the commit information near `browser/extensions/pdfjs/content/build/pdf.js` [e.g., see https://bug871530.bugzilla.mozilla.org/attachment.cgi?id=750657, was added3d (good), will be 869b878 (bad)] A Bugzilla patch contains the commit information near `browser/extensions/pdfjs/content/build/pdf.js`, e.g., see https://bug871530.bugzilla.mozilla.org/attachment.cgi?id=750657 (was added3d (good), will be 869b878 (bad)).
### Option 3 - Using MXR ### Using DXR
- If you know it was good in the Beta or Aurora branch, get the bad commit ID from MXR. Find the line with 'PDFJS.build = ' and copy the value in the single quotes, e.g., 4e83123. -f you know it was good in the Beta branch, get the bad commit ID from DXR. Find the line with `PDFJS.build =` and copy the value in the single quotes, for example `4e83123`. You can find PDF.js on DXR at http://dxr.mozilla.org/mozilla-beta/source/browser/extensions/pdfjs/content/build/pdf.js.
Aurora: http://mxr.mozilla.org/mozilla-aurora/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
## Verify the working version ## Verify the working version
- `git checkout <commit ID that you found above>` - Run `git checkout <commit ID that you found above>`.
- Full refresh (CTRL + Shift + R) Firefox and verify that the PDF is no longer broken - Do a full refresh (CTRL + Shift + R) Firefox and verify that rendering of the PDF is no longer broken.
- Mark it as good with `git bisect good` - Mark it as good with `git bisect good`.
## Continue bisecting ## Continue bisecting
- Full refresh (CTRL + Shift + R) of the viewer in Firefox - Do a 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 the current version does not work, mark it using `git bisect bad` - If the current version does not work, mark it using `git bisect bad`.
- Repeat the steps above until it converges to a single commit - Repeat the steps above until it converges to a single commit.