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

Removes reference to very old Python server (now Node.js server) and many textual improvements

Tim van der Meij 2015-05-08 22:05:04 +02:00
parent ee0219e402
commit 91f336a23d
1 changed files with 34 additions and 39 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

73
Bisecting-a-Regression.md

@ -1,56 +1,51 @@
## 1) At a minimum you'll need: ## 1) At a minimum you will need:
- git (on windows http://msysgit.github.io) - Git
- a server, if you have python (or XAMPP/WAMP) installed that will work - Node.js
## 2) Getting pdf.js ## 2) Getting PDF.js
- startup the git command line from above - Start the git command line
- move a directory where you want it to live, if you're using a server that isn't python go into the directory where your wwwroot is - Change to a directory where you want to place PDF.js
- `git clone https://github.com/mozilla/pdf.js.git` - Run `git clone git://github.com/mozilla/pdf.js.git`
## 3) Open pdf.js ## 3) Open PDF.js
### Option 1 - Python Server ### Option 1 - Node.js server
- `cd pdf.js/test` - Run `cd pdf.js`
- `python test.py --noDownload` - Run `node make server`
- open firefox and check http://localhost:8080/web/viewer.html goes to the pdf viewer - Open a browser and go to `http://localhost:8080/web/viewer.html`
- open different terminal tab/window
- `cd pdf.js`
### Option 2 - Other Server ### Option 2 - Another server
- 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 ## 4) Verify the regression
- Download the bad PDF and save it in pdf.js/test/pdfs - 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
- go to `<url from above>?file=../test/pdfs/<name of pdf>` and verify the PDF is broken
## 5) Start the bisecting process ## 5) 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 ## 6) Find bad commit ID
### Option 1 - Detecting version / commit of the pdf.js installed in the 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`
- Find commit in the line with 'PDFJS.build = ' - Find the commit in the line with 'PDFJS.build = '
- Find version in the line with 'PDFJS.version = ' - Find the version in the line with 'PDFJS.version = '
### Option 2 - Using bugzilla patch ### Option 2 - Using Bugzilla patch
- A bugzilla patch contains the commits information near ' - 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)]
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 ### Option 3 - Using MXR
- If you know it was good in beta or aurora get the bad commit id from mxr - 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.
Find the line with 'PDFJS.build = ' and copy the value in the single quotes e.g. 4e83123
auora - http://mxr.mozilla.org/mozilla-aurora/source/browser/extensions/pdfjs/content/build/pdf.js#24
beta - http://mxr.mozilla.org/mozilla-beta/source/browser/extensions/pdfjs/content/build/pdf.js#24
## 7) Verify the Working Version Aurora: http://mxr.mozilla.org/mozilla-aurora/source/browser/extensions/pdfjs/content/build/pdf.js#24
- `git checkout <commit id that you found above>` Beta: http://mxr.mozilla.org/mozilla-beta/source/browser/extensions/pdfjs/content/build/pdf.js#24
- Full refresh(ctr+shift+r) Firefox and verify the PDF no longer works.
## 7) Verify the working version
- `git checkout <commit ID that you found above>`
- Full refresh (CTRL + Shift + R) Firefox and verify that the PDF no longer works
- Mark it as good `git bisect good` - Mark it as good `git bisect good`
## 8) Continue bisecting ## 8) Continue bisecting
- Full refresh(ctr+shift+r) of the viewer in Firefox - Full refresh (CTRL + Shift + R) of the viewer in Firefox
- If the current version works `git bisect good` - If the current version works, mark it using `git bisect good`
- If it fails `git bisect bad` - If it fails, mark it using `git bisect bad`
- Repeat same steps as above if it's bad `git bisect bad` if it's good `git bisect good` - Repeat the steps above