Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(2945)

Unified Diff: blimp/docs/build.md

Issue 1772213002: Create doc on build arg best practices for Blimp. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Fix markdown syntax error. Created 4 years, 9 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « no previous file | tools/gn/docs/quick_start.md » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: blimp/docs/build.md
diff --git a/blimp/docs/build.md b/blimp/docs/build.md
index a235121d4852a023b5e6970b3ba408e8d4089a04..e5e20d7d73a0e415c04800003f307f89a5eacd97 100644
--- a/blimp/docs/build.md
+++ b/blimp/docs/build.md
@@ -3,10 +3,12 @@ Blimp only supports building using [GN](../../tools/gn/README.md). A quick
overview over how to use GN can be found in the GN
[quick start guide](../../tools/gn/docs/quick_start.md).
-There are three different build configurations depending on what you want to
+## Building
+
+There are two different build configurations depending on what you want to
build:
-## Android client
+### Android client
Create an out-directory and set the GN args:
@@ -35,7 +37,7 @@ To add your own build preferences
gn args out-android/Debug
```
-## Engine
+### Engine
Create another out-directory and set the GN args:
@@ -56,3 +58,24 @@ To add your own build preferences
```bash
gn args out-android/Debug
```
+
+## Adding new build arguments
+
+Adding new build arguments should be fairly rare. Arguments first need to be
+[declared](../../tools/gn/docs/quick_start.md#Add-a-new-build-argument).
+
+They can then be used to change how the binary is built or passed through to
+code as a
+[defines](../../tools/gn/docs/reference.md#defines_C-preprocessor-defines).
+
+Finally the Blimp argument templates should be updated to reflect the
+(non-default for Chrome) behavior desired by Blimp (see below).
+
+## Updating bulid arguments in templates
+
+Build argument templates exist for the client and engine at
+[`build/args/blimp_client.gn`](../../build/args/blimp_client.gn) and
+[`build/args/blimp_engine.gn`](../../build/args/blimp_engine.gn).
+
+These can be updated as in the same manner as your personal `args.gn` files
+to override default argument values.
« no previous file with comments | « no previous file | tools/gn/docs/quick_start.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698