summaryrefslogtreecommitdiffstats
path: root/toolkit/components/pdfjs/README.mozilla
diff options
context:
space:
mode:
Diffstat (limited to 'toolkit/components/pdfjs/README.mozilla')
-rw-r--r--toolkit/components/pdfjs/README.mozilla11
1 files changed, 11 insertions, 0 deletions
diff --git a/toolkit/components/pdfjs/README.mozilla b/toolkit/components/pdfjs/README.mozilla
new file mode 100644
index 0000000000..e34cf727d8
--- /dev/null
+++ b/toolkit/components/pdfjs/README.mozilla
@@ -0,0 +1,11 @@
+This is the PDF.js project output, https://github.com/mozilla/pdf.js
+
+The current upstream commit is documented in the revision field in moz.yaml
+
+To update PDF.js locally, run
+ ./mach vendor toolkit/components/pdfjs/moz.yaml
+
+To avoid cloning PDF.js locally for every invocation of that command, you can
+point ./mach vendor at a local repo by setting the PDFJS_CHECKOUT env var.
+The update process will perform a git fetch and checkout the latest version to
+update to, so any uncommited local changes will cause the update script to break. \ No newline at end of file