Document how to add setup-gn.py to `gclient runhooks`
Running setup-gn.py as part of `gclient runhooks` makes working
with the generated Xcode project on iOS much easier. Add some
documentation on how to achieve this.
Bug: none
Change-Id: Id8022ab403a1a1ab1a40f8b01d08e1e49c2554f8
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2287592
Reviewed-by: Gauthier Ambard <[email protected]>
Commit-Queue: Sylvain Defresne <[email protected]>
Cr-Commit-Position: refs/heads/master@{#786686}
diff --git a/docs/ios/build_instructions.md b/docs/ios/build_instructions.md
index 7677c91..dd3f606 100644
--- a/docs/ios/build_instructions.md
+++ b/docs/ios/build_instructions.md
@@ -100,6 +100,34 @@
the script directly or use either `gclient sync` or `gclient runhooks` which
will run `setup-gn.py` for you as part of the update hooks.
+You can add a custom hook to `.gclient` file to configure `setup-gn.py` to
+be run as part of `gclient runhooks`. In that case, your `.gclient` file
+would look like this:
+
+```
+solutions = [
+ {
+ "name" : "src",
+ "url" : "https://chromium.googlesource.com/chromium/src.git",
+ "deps_file" : "DEPS",
+ "managed" : False,
+ "custom_deps" : {},
+ "custom_vars" : {},
+ "custom_hooks": [{
+ "name": "setup_gn",
+ "pattern": ".",
+ "action": [
+ "python",
+ "src/ios/build/tools/setup-gn.py",
+ ]
+ }],
+ "safesync_url": "",
+ },
+]
+target_os = ["ios"]
+target_os_only = True
+```
+
You can also follow the manual instructions on the
[Mac page](../mac_build_instructions.md), but make sure you set the
GN arg `target_os="ios"`.
