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

Unified Diff: tools/gn/docs/reference.md

Issue 2006923004: Add support for user defined "pool" to GN. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Rebase Created 4 years, 6 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
Index: tools/gn/docs/reference.md
diff --git a/tools/gn/docs/reference.md b/tools/gn/docs/reference.md
index 59c54dcb099f8f411dd593293d009f03de94db31..c5b36cfd773c828755e4c9f8251179163d7bc12c 100644
--- a/tools/gn/docs/reference.md
+++ b/tools/gn/docs/reference.md
@@ -2143,6 +2143,47 @@
```
+## **pool**: Defines a pool object.
+
+```
+ Pool objects can be applied to a tool to limit the parallelism of the
+ build. This object has a single property "depth" corresponding to
+ the number of tasks that may run simultaneously.
+
+ As the file containing the pool definition may be executed in the
+ of more than one toolchain it is recommended to specify an explicit
+ toolchain when definining and referencing a pool.
+
+ A pool is referenced by its label just like a target.
+
+```
+
+### **Variables**
+
+```
+ depth*
+ * = required
+
+```
+
+### **Example**
+
+```
+ if (current_toolchain == default_toolchain) {
+ pool("link_pool") {
+ depth = 1
+ }
+ }
+
+ toolchain("toolchain") {
+ tool("link") {
+ command = "..."
+ pool = ":link_pool($default_toolchain)")
+ }
+ }
+
+
+```
## **print**: Prints to the console.
```
@@ -2913,6 +2954,14 @@
"{{output_dir}}/{{target_output_name}}.lib",
]
+ pool [label, optional]
+
+ Label of the pool to use for the tool. Pools are used to limit
+ the number of tasks that can execute concurrently during the
+ build.
+
+ See also "gn help pool".
+
link_output [string with substitutions]
depend_output [string with substitutions]
runtime_link_output [string with substitutions]

Powered by Google App Engine
This is Rietveld 408576698