aboutsummaryrefslogtreecommitdiffhomepage
path: root/site/dev/design
diff options
context:
space:
mode:
authorGravatar Hal Canary <halcanary@google.com>2016-11-11 11:40:04 -0500
committerGravatar Skia Commit-Bot <skia-commit-bot@chromium.org>2016-11-11 16:59:14 +0000
commit64dded3d95be625b65120a91ed29dd58112489d3 (patch)
tree10cb014a0f6790ddb548504585fd06fa8437cccd /site/dev/design
parent58b130681db4432c4937c2cb1b2529de628c6b19 (diff)
Documentation: more gn, less gyp
GOLD_TRYBOT_URL= https://gold.skia.org/search?issue=4698 NOTRY=true DOCS_PREVIEW= https://skia.org/?cl=4698 Change-Id: I03100542752a769060a7f0c9671cc44acbea2e48 Reviewed-on: https://skia-review.googlesource.com/4698 Reviewed-by: Mike Klein <mtklein@chromium.org> Commit-Queue: Hal Canary <halcanary@google.com>
Diffstat (limited to 'site/dev/design')
-rw-r--r--site/dev/design/sync-and-gyp.md24
-rw-r--r--site/dev/design/sync.md18
2 files changed, 18 insertions, 24 deletions
diff --git a/site/dev/design/sync-and-gyp.md b/site/dev/design/sync-and-gyp.md
deleted file mode 100644
index 894ad9a5c0..0000000000
--- a/site/dev/design/sync-and-gyp.md
+++ /dev/null
@@ -1,24 +0,0 @@
-sync-and-gyp
-============
-
-[`sync-and-gyp`](https://skia.googlesource.com/skia.git/+/master/bin/sync-and-gyp)
-is a Python program that wraps `gclient sync` and `gyp_skia`.
-Motivations for using it:
-
-- Fewer steps to configure and compile Skia and Skia's dependencies.
- This makes documentation cleaner, too.
-
-- Written in Python, so it will work on all platforms. Python is
- already necessary for gyp.
-
-- Sets up gclient better than `gclient config`, which has been broken.
-
-- Checks to see if the `DEPS` file has changed since it last ran
- `gclient sync`. If not, it skips that step.
-
-- Checks to see if gyp needs to be re-run (it checks environment
- variables and changed or added files); if not, it skips running
- `gyp_skia`.
-
-- Since running `sync-and-gyp` is fast when it can do nothing, it is
- easy to do before every recompile of Skia. This is a good habit.
diff --git a/site/dev/design/sync.md b/site/dev/design/sync.md
new file mode 100644
index 0000000000..d7c192fdbc
--- /dev/null
+++ b/site/dev/design/sync.md
@@ -0,0 +1,18 @@
+sync
+====
+
+[`sync`](https://skia.googlesource.com/skia.git/+/master/bin/sync)
+is a Python program that wraps `gclient sync` and `fetch-gn`.
+Motivations for using it:
+
+- Written in Python, so it will work on all platforms.
+
+- Sets up gclient better than `gclient config`, which has been broken.
+
+- Checks to see if the `DEPS` file has changed since it last ran
+ `gclient sync`. If not, it skips that step.
+
+- Calls `fetch-gn` if needed.
+
+- Since running `sync` is fast when it can do nothing, it is
+ easy to do before every recompile of Skia. This is a good habit.