summaryrefslogtreecommitdiffstats
path: root/third_party/libwebrtc/build/args/chromeos/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /third_party/libwebrtc/build/args/chromeos/README.md
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'third_party/libwebrtc/build/args/chromeos/README.md')
-rw-r--r--third_party/libwebrtc/build/args/chromeos/README.md52
1 files changed, 52 insertions, 0 deletions
diff --git a/third_party/libwebrtc/build/args/chromeos/README.md b/third_party/libwebrtc/build/args/chromeos/README.md
new file mode 100644
index 0000000000..e02e185519
--- /dev/null
+++ b/third_party/libwebrtc/build/args/chromeos/README.md
@@ -0,0 +1,52 @@
+This directory is used to store GN arg mapping for Chrome OS boards.
+
+Files in this directory are populated by running `gclient sync` with specific
+arguments set in the .gclient file. Specifically:
+* The file must have a top-level variable set: `target_os = ["chromeos"]`
+* The `"custom_vars"` parameter of the chromium/src.git solution must include
+ the parameter: `"cros_boards": "{BOARD_NAMES}"` where `{BOARD_NAMES}` is a
+ colon-separated list of boards you'd like to checkout.
+* If you'd like to a checkout a QEMU-bootable image for a given board, include
+ it in the `cros_boards_with_qemu_images` var rather than the `cros_boards`
+ var.
+
+A typical .gclient file is a sibling of the src/ directory, and might look like
+this:
+```
+solutions = [
+ {
+ "url": "https://chromium.googlesource.com/chromium/src.git",
+ "managed": False,
+ "name": "src",
+ "custom_deps": {},
+ "custom_vars" : {
+ "checkout_src_internal": True,
+ "cros_boards": "eve:kevin",
+ # If a QEMU-bootable image is desired for any board, move it from
+ # the previous var to the following:
+ "cros_boards_with_qemu_images": "amd64-generic",
+ },
+ },
+]
+target_os = ["chromeos"]
+```
+
+To use these files in a build, simply add the following line to your GN args:
+```
+import("//build/args/chromeos/${some_board}.gni")
+```
+
+That will produce a Chrome OS build of Chrome very similar to what is shipped
+for that device. You can also supply additional args or even overwrite ones
+supplied in the .gni file after the `import()` line. For example, the following
+args will produce a debug build of Chrome for board=eve using goma:
+```
+import("//build/args/chromeos/eve.gni")
+
+is_debug = true
+use_goma = true
+goma_dir = "/path/to/goma/"
+```
+
+TODO(bpastene): Make 'cros_boards' a first class citizen in gclient and replace
+it with 'target_boards' instead.