1GN(1) User Commands GN(1)
2
6 gn - Documentation for GN
7
9 Commands (type gn help <command>" for more help):"
10 analyze:
11 Analyze which targets are affected by a list of files.
12 args:
14 Display or configure arguments declared by the build.
15 check:
17 Check header dependencies.
18 clean:
20 Cleans the output directory.
21 clean_stale:
23 Cleans the stale output files from the output directory.
24 desc:
26 Show lots of insightful information about a target or config.
27 format:
29 Format .gn files.
30 gen:
32 Generate ninja files.
33 help:
35 Does what you think.
36 ls:
38 List matching targets.
39 meta:
41 List target metadata collection results.
42 outputs:
44 Which files a source/target make.
45 path:
47 Find paths between two targets.
48 refs:
50 Find stuff referencing a target or file.
51 Target declarations (type gn help <function>" for more help):"
53 action:
54 Declare a target that runs a script a single time.
55 action_foreach:
57 Declare a target that runs a script over a set of files.
58 bundle_data:
60 [iOS/macOS] Declare a target without output.
61 copy:
63 Declare a target that copies files.
64 create_bundle:
66 [iOS/macOS] Build an iOS or macOS bundle.
67 executable:
69 Declare an executable target.
70 generated_file:
72 Declare a generated_file target.
73 group:
75 Declare a named group of targets.
76 loadable_module:
78 Declare a loadable module target.
79 rust_library:
81 Declare a Rust library target.
82 rust_proc_macro:
84 Declare a Rust procedural macro target.
85 shared_library:
87 Declare a shared library target.
88 source_set:
90 Declare a source set target.
91 static_library:
93 Declare a static library target.
94 target:
96 Declare a target with the given programmatic type.
97 Buildfile functions (type gn help <function>" for more help):"
99 assert:
100 Assert an expression is true at generation time.
101 config:
103 Defines a configuration object.
104 declare_args:
106 Declare build arguments.
107 defined:
109 Returns whether an identifier is defined.
110 exec_script:
112 Synchronously run a script and return the output.
113 filter_exclude:
115 Remove values that match a set of patterns.
116 filter_include:
118 Remove values that do not match a set of patterns.
119 foreach:
121 Iterate over a list.
122 forward_variables_from:
124 Copies variables from a different scope.
125 get_label_info:
127 Get an attribute from a target's label.
128 get_path_info:
130 Extract parts of a file or directory name.
131 get_target_outputs:
133 [file list] Get the list of outputs from a target.
134 getenv:
136 Get an environment variable.
137 import:
139 Import a file into the current scope.
140 not_needed:
142 Mark variables from scope as not needed.
143 pool:
145 Defines a pool object.
146 print:
148 Prints to the console.
149 print_stack_trace:
151 Prints a stack trace.
152 process_file_template:
154 Do template expansion over a list of files.
155 read_file:
157 Read a file into a variable.
158 rebase_path:
160 Rebase a file or directory to another location.
161 set_default_toolchain:
163 Sets the default toolchain name.
164 set_defaults:
166 Set default values for a target type.
167 split_list:
169 Splits a list into N different sub-lists.
170 string_join:
172 Concatenates a list of strings with a separator.
173 string_replace:
175 Replaces substring in the given string.
176 string_split:
178 Split string into a list of strings.
179 template:
181 Define a template rule.
182 tool:
184 Specify arguments to a toolchain tool.
185 toolchain:
187 Defines a toolchain.
188 write_file:
190 Write a file to disk.
191 Built-in predefined variables (type gn help <variable>" for more help):"
193 current_cpu:
194 [string] The processor architecture of the current toolchain.
195 current_os:
197 [string] The operating system of the current toolchain.
198 current_toolchain:
200 [string] Label of the current toolchain.
201 default_toolchain:
203 [string] Label of the default toolchain.
204 gn_version:
206 [number] The version of gn.
207 host_cpu:
209 [string] The processor architecture that GN is running on.
210 host_os:
212 [string] The operating system that GN is running on.
213 invoker:
215 [string] The invoking scope inside a template.
216 python_path:
218 [string] Absolute path of Python.
219 root_build_dir:
221 [string] Directory where build commands are run.
222 root_gen_dir:
224 [string] Directory for the toolchain's generated files.
225 root_out_dir:
227 [string] Root directory for toolchain output files.
228 target_cpu:
230 [string] The desired cpu architecture for the build.
231 target_gen_dir:
233 [string] Directory for a target's generated files.
234 target_name:
236 [string] The name of the current target.
237 target_os:
239 [string] The desired operating system for the build.
240 target_out_dir:
242 [string] Directory for target output files.
243 Variables you set in targets (type gn help <variable>" for more help):"
245 aliased_deps:
246 [scope] Set of crate-dependency pairs.
247 all_dependent_configs:
249 [label list] Configs to be forced on dependents.
250 allow_circular_includes_from:
252 [label list] Permit includes from deps.
253 arflags:
255 [string list] Arguments passed to static_library archiver.
256 args:
258 [string list] Arguments passed to an action.
259 asmflags:
261 [string list] Flags passed to the assembler.
262 assert_no_deps:
264 [label pattern list] Ensure no deps on these targets.
265 bridge_header:
267 [string] Path to C/Objective-C compatibility header.
268 bundle_contents_dir:
270 Expansion of {{bundle_contents_dir}} in create_bundle.
271 bundle_deps_filter:
273 [label list] A list of labels that are filtered out.
274 bundle_executable_dir:
276 Expansion of {{bundle_executable_dir}} in create_bundle
277 bundle_resources_dir:
279 Expansion of {{bundle_resources_dir}} in create_bundle.
280 bundle_root_dir:
282 Expansion of {{bundle_root_dir}} in create_bundle.
283 cflags:
285 [string list] Flags passed to all C compiler variants.
286 cflags_c:
288 [string list] Flags passed to the C compiler.
289 cflags_cc:
291 [string list] Flags passed to the C++ compiler.
292 cflags_objc:
294 [string list] Flags passed to the Objective C compiler.
295 cflags_objcc:
297 [string list] Flags passed to the Objective C++ compiler.
298 check_includes:
300 [boolean] Controls whether a target's files are checked.
301 code_signing_args:
303 [string list] Arguments passed to code signing script.
304 code_signing_outputs:
306 [file list] Output files for code signing step.
307 code_signing_script:
309 [file name] Script for code signing.
310 code_signing_sources:
312 [file list] Sources for code signing step.
313 complete_static_lib:
315 [boolean] Links all deps into a static library.
316 configs:
318 [label list] Configs applying to this target or config.
319 contents:
321 Contents to write to file.
322 crate_name:
324 [string] The name for the compiled crate.
325 crate_root:
327 [string] The root source file for a binary or library.
328 crate_type:
330 [string] The type of linkage to use on a shared_library.
331 data:
333 [file list] Runtime data file dependencies.
334 data_deps:
336 [label list] Non-linked dependencies.
337 data_keys:
339 [string list] Keys from which to collect metadata.
340 defines:
342 [string list] C preprocessor defines.
343 depfile:
345 [string] File name for input dependencies for actions.
346 deps:
348 [label list] Private linked dependencies.
349 externs:
351 [scope] Set of Rust crate-dependency pairs.
352 framework_dirs:
354 [directory list] Additional framework search directories.
355 frameworks:
357 [name list] Name of frameworks that must be linked.
358 friend:
360 [label pattern list] Allow targets to include private headers.
361 gen_deps:
363 [label list] Declares targets that should generate when this
364 one does.
365 include_dirs:
367 [directory list] Additional include directories.
368 inputs:
370 [file list] Additional compile-time dependencies.
371 ldflags:
373 [string list] Flags passed to the linker.
374 lib_dirs:
376 [directory list] Additional library directories.
377 libs:
379 [string list] Additional libraries to link.
380 metadata:
382 [scope] Metadata of this target.
383 mnemonic:
385 [string] Prefix displayed when ninja runs this action.
386 module_name:
388 [string] The name for the compiled module.
389 output_conversion:
391 Data format for generated_file targets.
392 output_dir:
394 [directory] Directory to put output file in.
395 output_extension:
397 [string] Value to use for the output's file extension.
398 output_name:
400 [string] Name for the output file other than the default.
401 output_prefix_override:
403 [boolean] Don't use prefix for output name.
404 outputs:
406 [file list] Output files for actions and copy targets.
407 partial_info_plist:
409 [filename] Path plist from asset catalog compiler.
410 pool:
412 [string] Label of the pool used by binary targets and actions.
413 precompiled_header:
415 [string] Header file to precompile.
416 precompiled_header_type:
418 [string] "gcc" or "msvc".
419 precompiled_source:
421 [file name] Source file to precompile.
422 product_type:
424 [string] Product type for the bundle.
425 public:
427 [file list] Declare public header files for a target.
428 public_configs:
430 [label list] Configs applied to dependents.
431 public_deps:
433 [label list] Declare public dependencies.
434 rebase:
436 [boolean] Rebase collected metadata as files.
437 response_file_contents:
439 [string list] Contents of .rsp file for actions.
440 script:
442 [file name] Script file for actions.
443 sources:
445 [file list] Source files for a target.
446 swiftflags:
448 [string list] Flags passed to the swift compiler.
449 testonly:
451 [boolean] Declares a target must only be used for testing.
452 transparent:
454 [bool] True if the bundle is transparent.
455 visibility:
457 [label list] A list of labels that can depend on a target.
458 walk_keys:
460 [string list] Key(s) for managing the metadata collection walk.
461 weak_frameworks:
463 [name list] Name of frameworks that must be weak linked.
464 write_runtime_deps:
466 Writes the target's runtime_deps to the given path.
467 xcasset_compiler_flags:
469 [string list] Flags passed to xcassets compiler
470 xcode_extra_attributes:
472 [scope] Extra attributes for Xcode projects.
473 xcode_test_application_name:
475 [string] Name for Xcode test target.
476 Other help topics:
478 all:
479 Print all the help at once
480 buildargs:
482 How build arguments work.
483 dotfile:
485 Info about the toplevel .gn file.
486 execution:
488 Build graph and execution overview.
489 grammar:
491 Language and grammar for GN build files.
492 input_conversion:
494 Processing input from exec_script and read_file.
495 file_pattern:
497 Matching more than one file.
498 label_pattern:
500 Matching more than one label.
501 labels:
503 About labels.
504 metadata_collection:
506 About metadata and its collection.
507 ninja_rules:
509 How Ninja build rules are named.
510 nogncheck:
512 Annotating includes for checking.
513 output_conversion:
515 Specifies how to transform a value to output.
516 runtime_deps:
518 How runtime dependency computation works.
519 source_expansion:
521 Map sources to outputs for scripts.
522 switches:
524 Show available command-line switches.
525gn 2125 (85bd0a62938b) November 2023 GN(1)