summaryrefslogtreecommitdiffstats
path: root/gfx/skia/README
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--gfx/skia/README3
-rw-r--r--gfx/skia/README_COMMITTING10
-rw-r--r--gfx/skia/README_MOZILLA33
3 files changed, 46 insertions, 0 deletions
diff --git a/gfx/skia/README b/gfx/skia/README
new file mode 100644
index 0000000000..84e4ecc907
--- /dev/null
+++ b/gfx/skia/README
@@ -0,0 +1,3 @@
+Skia is a complete 2D graphic library for drawing Text, Geometries, and Images.
+
+See full details, and build instructions, at http://code.google.com/p/skia/wiki/DocRoot
diff --git a/gfx/skia/README_COMMITTING b/gfx/skia/README_COMMITTING
new file mode 100644
index 0000000000..4014ea3c7f
--- /dev/null
+++ b/gfx/skia/README_COMMITTING
@@ -0,0 +1,10 @@
+Any changes to Skia should have at a minimum both a Mozilla bug tagged with the [skia-upstream]
+whiteboard tag, and also an upstream bug and review request. Any patches that do ultimately land
+in mozilla-central must be reviewed by a Skia submodule peer.
+
+See https://wiki.mozilla.org/Modules/Core#Graphics for current peers.
+
+In most cases the patch will need to have an r+ from upstream before it is eligible to land here.
+
+For information on submitting upstream, see:
+https://sites.google.com/site/skiadocs/developer-documentation/contributing-code/how-to-submit-a-patch
diff --git a/gfx/skia/README_MOZILLA b/gfx/skia/README_MOZILLA
new file mode 100644
index 0000000000..af7a003743
--- /dev/null
+++ b/gfx/skia/README_MOZILLA
@@ -0,0 +1,33 @@
+This is an import of Skia. See skia/include/core/SkMilestone.h for the milestone number.
+
+Current upstream hash: 4655534302e6a3601c77eae70cc65b202609ab66 (milestone 79)
+
+How to update
+=============
+
+To update to a new version of Skia:
+
+- Clone Skia from upstream using the instructions here: https://skia.org/user/download
+ Usually: `git clone https://skia.googlesource.com/skia`
+- Checkout the wanted revision (`git checkout -b <hash>`). See below for the current
+ hash.
+- Copy the entire source tree from a Skia clone to mozilla-central/gfx/skia/skia
+ (make sure that . files are also copied as .gn is mandatory).
+- Download gn: cd gfx/skia/skia/bin && python fetch-gn && cd -
+ Note that these scripts might need Python 2.7. Please use a virtualenv if needed.
+- cd gfx/skia && ./generate_mozbuild.py
+
+Once that's done, use git status to view the files that have changed. Keep an eye on GrUserConfig.h
+and SkUserConfig.h as those probably don't want to be overwritten by upstream versions.
+
+This process will be made more automatic in the future.
+
+Debug
+=====
+
+In case of issues when updating, run the command manually.
+For example, if the following error occurs:
+`subprocess.CalledProcessError: Command 'cd skia && bin/gn gen out/linux --args='target_os="linux" ' > /dev/null && bin/gn desc out/linux :skia sources' returned non-zero exit status 1`
+Run:
+`cd skia && bin/gn gen out/linux --args='target_os="linux"'`
+and look at the errors.