Lines Matching defs:name
182 ### <a name="cmd_analyze"></a>**gn analyze <out_dir> <input_path> <output_path>**
258 ### <a name="cmd_args"></a>**gn args**: (command-line tool)
269 #### **Usage**
324 #### **Examples**
347 …cmd_check"></a>**gn check <out_dir> [<label_pattern>] [\--force] [\--check-generated]**
362 #### **Command-specific switches**
387 #### **What gets checked**
446 #### **Advice on fixing problems**
473 #### **Examples**
485 ### <a name="cmd_clean"></a>**gn clean <out_dir>...**
491 ### <a name="cmd_clean_stale"></a>**gn clean_stale [\--ninja-executable=...] <out_dir>...**
503 #### **Options**
509 ### <a name="cmd_desc"></a>**gn desc**
523 #### **Possibilities for <what to show>**
571 #### **Shared flags**
586 #### **Target flags**
597 #### **Configs**
607 #### **Printing outputs**
615 #### **Printing deps**
658 #### **Note**
667 #### **Examples**
681 …# <a name="cmd_format"></a>**gn format [\--dump-tree] (\--stdin | <list of build_files...>)**
697 #### **Arguments**
722 #### **Examples**
730 ### <a name="cmd_gen"></a>**gn gen [\--check] [<ide options>] <out_dir>**
748 #### **General options**
765 #### **IDE options**
791 #### **Visual Studio Flags**
815 #### **Xcode Flags**
840 #### **QtCreator Flags**
849 #### **Eclipse IDE Support**
861 #### **Generic JSON Output**
882 #### **Compilation Database**
907 ### <a name="cmd_help"></a>**gn help <anything>**
916 #### **Switches**
923 #### **Example**
929 …e="cmd_ls"></a>**gn ls <out_dir> [<label_pattern>] [\--default-toolchain] [\--as=...]**
942 #### **Options**
976 #### **Examples**
997 ### <a name="cmd_meta"></a>**gn meta**
1009 #### **Arguments**
1034 #### **Examples**
1054 ### <a name="cmd_outputs"></a>**gn outputs <out_dir> <list of target or file names...>**
1071 #### **Target outputs**
1082 #### **File outputs**
1096 #### **Example**
1108 ### <a name="cmd_path"></a>**gn path <out_dir> <target_one> <target_two>**
1123 #### **Interesting paths**
1132 #### **Options**
1148 #### **Example**
1153 ### <a name="cmd_refs"></a>**gn refs**
1182 #### **Options**
1237 #### **Examples (target input)**
1261 #### **Examples (file input)**
1282 ### <a name="func_action"></a>**action**: Declare a target that runs a script a single time.
1290 #### **Inputs**
1320 #### **Outputs**
1342 #### **File name handling**
1351 #### **Variables**
1359 #### **Example**
1376 …nc_action_foreach"></a>**action_foreach**: Declare a target that runs a script over a set of files.
1384 #### **Inputs**
1412 #### **Outputs**
1431 #### **File name handling**
1440 #### **Variables**
1448 #### **Example**
1475 ### <a name="func_bundle_data"></a>**bundle_data**: [iOS/macOS] Declare a target without output.
1493 #### **Variables**
1500 #### **Examples**
1529 ### <a name="func_copy"></a>**copy**: Declare a target that copies files.
1531 #### **File name handling**
1548 #### **Examples**
1566 ### <a name="func_create_bundle"></a>**create_bundle**: [ios/macOS] Build an iOS or macOS bundle.
1589 #### **Code signing**
1607 #### **Variables**
1617 #### **Example**
1716 ### <a name="func_executable"></a>**executable**: Declare an executable target.
1718 #### **Language and compilation**
1728 #### **Variables**
1742 ### <a name="func_generated_file"></a>**generated_file**: Declare a generated_file target.
1766 #### **Example (metadata collection)**
1864 #### **Variables**
1875 ### <a name="func_group"></a>**group**: Declare a named group of targets.
1883 #### **Variables**
1890 #### **Example**
1900 ### <a name="func_loadable_module"></a>**loadable_module**: Declare a loadable module target.
1912 #### **Language and compilation**
1922 #### **Variables**
1936 ### <a name="func_rust_library"></a>**rust_library**: Declare a Rust library target.
1944 #### **Language and compilation**
1954 #### **Variables**
1968 ### <a name="func_rust_proc_macro"></a>**rust_proc_macro**: Declare a Rust procedural macro target.
1979 #### **Language and compilation**
1989 #### **Variables**
2003 ### <a name="func_shared_library"></a>**shared_library**: Declare a shared library target.
2013 #### **Language and compilation**
2023 #### **Variables**
2037 ### <a name="func_source_set"></a>**source_set**: Declare a source set target.
2043 #### **C-language source_sets**
2068 #### **Variables**
2081 ### <a name="func_static_library"></a>**static_library**: Declare a static library target.
2091 #### **Variables**
2112 ### <a name="func_target"></a>**target**: Declare an target with the given programmatic type.
2131 #### **Example**
2146 ### <a name="func_assert"></a>**assert**: Assert an expression is true at generation time.
2156 #### **Examples**
2162 ### <a name="func_config"></a>**config**: Defines a configuration object.
2183 #### **More background**
2201 #### **Variables valid in a config definition**
2212 #### **Variables on a target used to apply configs**
2218 #### **Example**
2230 ### <a name="func_declare_args"></a>**declare_args**: Declare build arguments.
2278 #### **Example**
2291 ### <a name="func_defined"></a>**defined**: Returns whether an identifier is defined.
2309 #### **Example**
2325 …# <a name="func_exec_script"></a>**exec_script**: Synchronously run a script and return the output.
2347 #### **Arguments**:
2374 #### **Example**
2385 …# <a name="func_filter_exclude"></a>**filter_exclude**: Remove values that match a set of patterns.
2397 #### **Examples**
2403 …me="func_filter_include"></a>**filter_include**: Remove values that do not match a set of patterns.
2415 #### **Examples**
2421 ### <a name="func_foreach"></a>**foreach**: Iterate over a list.
2442 #### **Example**
2455 …nc_forward_variables_from"></a>**forward_variables_from**: Copies variables from a different scope.
2485 #### **Examples**
2533 ### <a name="func_get_label_info"></a>**get_label_info**: Get an attribute from a target's label.
2545 #### **Possible values for the "what" parameter**
2588 #### **Examples**
2597 ### <a name="func_get_path_info"></a>**get_path_info**: Extract parts of a file or directory name.
2607 #### **Possible values for the "what" parameter**
2665 #### **Examples**
2677 …_get_target_outputs"></a>**get_target_outputs**: [file list] Get the list of outputs from a target.
2694 #### **Return value**
2714 #### **Example**
2728 ### <a name="func_getenv"></a>**getenv**: Get an environment variable.
2743 #### **Example**
2748 ### <a name="func_import"></a>**import**: Import a file into the current scope.
2775 #### **Examples**
2783 ### <a name="func_not_needed"></a>**not_needed**: Mark variables from scope as not needed.
2796 #### **Example**
2804 ### <a name="func_pool"></a>**pool**: Defines a pool object.
2825 #### **Variables**
2832 #### **Example**
2848 ### <a name="func_print"></a>**print**: Prints to the console.
2861 #### **Examples**
2868 …c_process_file_template"></a>**process_file_template**: Do template expansion over a list of files.
2883 #### **Arguments**
2895 #### **Example**
2913 ### <a name="func_read_file"></a>**read_file**: Read a file into a variable.
2922 #### **Arguments**
2932 #### **Example**
2937 ### <a name="func_rebase_path"></a>**rebase_path**: Rebase a file or directory to another location.
2964 #### **Arguments**
2988 #### **Return value**
3003 #### **Example**
3033 …a name="func_set_default_toolchain"></a>**set_default_toolchain**: Sets the default toolchain name.
3054 #### **Argument**
3061 #### **Example**
3073 ### <a name="func_set_defaults"></a>**set_defaults**: Set default values for a target type.
3094 #### **Example**
3107 ### <a name="func_split_list"></a>**split_list**: Splits a list into N different sub-lists.
3120 #### **Example**
3130 ### <a name="func_string_join"></a>**string_join**: Concatenates a list of strings with a separator.
3138 #### **Examples**
3146 ### <a name="func_string_replace"></a>**string_replace**: Replaces substring in the given string.
3157 #### **Example**
3167 ### <a name="func_string_split"></a>**string_split**: Split string into a list of strings.
3179 #### **Examples without a separator (split on whitespace)**:
3187 #### **Examples with a separator (split on separators)**:
3194 ### <a name="func_template"></a>**template**: Define a template rule.
3208 #### **Variables and templates**:
3239 #### **Target naming**
3266 #### **Overriding builtin targets**
3282 #### **Example of defining a template**
3337 #### **Example of invoking the resulting template**
3357 ### <a name="func_tool"></a>**tool**: Specify arguments to a toolchain tool.
3359 #### **Usage**
3367 #### **Tool types**
3403 #### **Tool variables**
3684 #### **Expansions for tool variables**
3931 #### **Separate linking and dependencies for shared libraries**
3964 #### **Example**
3984 ### <a name="func_toolchain"></a>**toolchain**: Defines a toolchain.
3991 #### **Toolchain overview**
4030 #### **Functions and variables**
4087 #### **Example of defining a toolchain**
4115 #### **Example of cross-toolchain dependencies**
4138 ### <a name="func_write_file"></a>**write_file**: Write a file to disk.
4155 #### **Arguments**
4169 …<a name="var_current_cpu"></a>**current_cpu**: The processor architecture of the current toolchain.
4183 ### <a name="var_current_os"></a>**current_os**: The operating system of the current toolchain.
4197 ### <a name="var_current_toolchain"></a>**current_toolchain**: Label of the current toolchain.
4205 #### **Example**
4212 …<a name="var_default_toolchain"></a>**default_toolchain**: [string] Label of the default toolchain.
4218 ### <a name="var_gn_version"></a>**gn_version**: [number] The version of gn.
4224 #### **Example**
4229 ### <a name="var_host_cpu"></a>**host_cpu**: The processor architecture that GN is running on.
4241 #### **Some possible values**
4247 ### <a name="var_host_os"></a>**host_os**: [string] The operating system that GN is running on.
4257 #### **Some possible values**
4264 ### <a name="var_invoker"></a>**invoker**: [string] The invoking scope inside a template.
4281 #### **Example**
4295 ### <a name="var_python_path"></a>**python_path**: Absolute path of Python.
4302 … name="var_root_build_dir"></a>**root_build_dir**: [string] Directory where build commands are run.
4311 ### <a name="var_root_gen_dir"></a>**root_gen_dir**: Directory for the toolchain's generated files.
4326 …a name="var_root_out_dir"></a>**root_out_dir**: [string] Root directory for toolchain output files.
4344 #### **Example**
4352 ### <a name="var_target_cpu"></a>**target_cpu**: The desired cpu architecture for the build.
4372 #### **Possible values**
4381 ### <a name="var_target_gen_dir"></a>**target_gen_dir**: Directory for a target's generated files.
4397 #### **Example**
4405 ### <a name="var_target_name"></a>**target_name**: [string] The name of the current target.
4426 #### **Example**
4444 ### <a name="var_target_os"></a>**target_os**: The desired operating system for the build.
4474 #### **Possible values**
4485 ### <a name="var_target_out_dir"></a>**target_out_dir**: [string] Directory for target output files.
4500 #### **Example**
4510 ### <a name="var_aliased_deps"></a>**aliased_deps**: [scope] Set of crate-dependency pairs.
4540 …name="var_all_dependent_configs"></a>**all_dependent_configs**: Configs to be forced on dependents.
4559 #### **Ordering of flags and values**
4576 …"var_allow_circular_includes_from"></a>**allow_circular_includes_from**: Permit includes from deps.
4590 #### **Details**
4611 #### **Danger**
4630 #### **Example**
4649 ### <a name="var_arflags"></a>**arflags**: Arguments passed to static_library archiver.
4665 #### **Ordering of flags and values**
4682 ### <a name="var_args"></a>**args**: (target variable) Arguments passed to an action.
4691 ### <a name="var_asmflags"></a>**asmflags**: Flags passed to the assembler.
4700 #### **Ordering of flags and values**
4717 ### <a name="var_assert_no_deps"></a>**assert_no_deps**: Ensure no deps on these targets.
4745 #### **Example**
4757 …ame="var_bridge_header"></a>**bridge_header**: [string] Path to C/Objective-C compatibility header.
4765 …name="var_bundle_contents_dir"></a>**bundle_contents_dir**: Expansion of {{bundle_contents_dir}} in
4777 …undle_deps_filter"></a>**bundle_deps_filter**: [label list] A list of labels that are filtered out.
4793 #### **Example**
4808 ### <a name="var_bundle_executable_dir"></a>**bundle_executable_dir**
4822 ### <a name="var_bundle_resources_dir"></a>**bundle_resources_dir**
4836 …e="var_bundle_root_dir"></a>**bundle_root_dir**: Expansion of {{bundle_root_dir}} in create_bundle.
4846 #### **Example**
4862 ### <a name="var_cflags"></a>**cflags***: Flags passed to the C compiler.
4879 #### **Ordering of flags and values**
4896 ### <a name="var_cflags_c"></a>**cflags***: Flags passed to the C compiler.
4913 #### **Ordering of flags and values**
4930 ### <a name="var_cflags_cc"></a>**cflags***: Flags passed to the C compiler.
4947 #### **Ordering of flags and values**
4964 ### <a name="var_cflags_objc"></a>**cflags***: Flags passed to the C compiler.
4981 #### **Ordering of flags and values**
4998 ### <a name="var_cflags_objcc"></a>**cflags***: Flags passed to the C compiler.
5015 #### **Ordering of flags and values**
5032 …ar_check_includes"></a>**check_includes**: [boolean] Controls whether a target's files are checked.
5051 #### **Example**
5060 …ode_signing_args"></a>**code_signing_args**: [string list] Arguments passed to code signing script.
5069 …code_signing_outputs"></a>**code_signing_outputs**: [file list] Output files for code signing step.
5077 …a name="var_code_signing_script"></a>**code_signing_script**: [file name] Script for code signing."
5085 …"var_code_signing_sources"></a>**code_signing_sources**: [file list] Sources for code signing step.
5094 …r_complete_static_lib"></a>**complete_static_lib**: [boolean] Links all deps into a static library.
5121 #### **Example**
5129 ### <a name="var_configs"></a>**configs**: Configs applying to this target or config.
5135 #### **Configs on a target**
5153 #### **Configs on a config**
5177 #### **Ordering of flags and values**
5195 #### **Example**
5222 ### <a name="var_contents"></a>**contents**: Contents to write to file.
5228 ### <a name="var_crate_name"></a>**crate_name**: [string] The name for the compiled crate.
5236 …<a name="var_crate_root"></a>**crate_root**: [string] The root source file for a binary or library.
5249 … name="var_crate_type"></a>**crate_type**: [string] The type of linkage to use on a shared_library.
5269 ### <a name="var_data"></a>**data**: Runtime data file dependencies.
5298 ### <a name="var_data_deps"></a>**data_deps**: Non-linked dependencies.
5316 #### **Example**
5324 ### <a name="var_data_keys"></a>**data_keys**: Keys from which to collect metadata.
5333 ### <a name="var_defines"></a>**defines**: C preprocessor defines.
5342 #### **Ordering of flags and values**
5360 #### **Example**
5365 ### <a name="var_depfile"></a>**depfile**: [string] File name for input dependencies for actions.
5389 #### **Example**
5404 ### <a name="var_deps"></a>**deps**: Private linked dependencies.
5415 #### **Details of dependency propagation**
5437 ### <a name="var_externs"></a>**externs**: [scope] Set of Rust crate-dependency pairs.
5447 #### **Examples**
5461 …r_framework_dirs"></a>**framework_dirs**: [directory list] Additional framework search directories.
5470 #### **Ordering of flags and values**
5488 #### **Example**
5493 ### <a name="var_frameworks"></a>**frameworks**: [name list] Name of frameworks that must be linked.
5502 #### **Ordering of flags and values**
5520 #### **Example**
5525 ### <a name="var_friend"></a>**friend**: Allow targets to include private headers.
5552 #### **Example**
5586 ### <a name="var_include_dirs"></a>**include_dirs**: Additional include directories.
5595 #### **Ordering of flags and values**
5613 #### **Example**
5618 ### <a name="var_inputs"></a>**inputs**: Additional compile-time dependencies.
5628 #### **Inputs for actions**
5649 #### **Script input gotchas**
5666 #### **Inputs for binary targets**
5680 #### **Example**
5688 ### <a name="var_ldflags"></a>**ldflags**: Flags passed to the linker.
5703 #### **Ordering of flags and values**
5720 ### <a name="var_lib_dirs"></a>**lib_dirs**: Additional library directories.
5736 #### **Ordering of flags and values**
5758 #### **Example**
5763 ### <a name="var_libs"></a>**libs**: Additional libraries to link.
5778 #### **Types of libs**
5799 #### **Ordering of flags and values**
5821 #### **Examples**
5830 ### <a name="var_metadata"></a>**metadata**: Metadata of this target.
5843 #### **Example**
5855 ### <a name="var_module_name"></a>**module_name**: [string] The name for the compiled module.
5862 … <a name="var_output_conversion"></a>**output_conversion**: Data format for generated_file targets.
5868 ### <a name="var_output_dir"></a>**output_dir**: [directory] Directory to put output file in.
5887 #### **Example**
5895 …name="var_output_extension"></a>**output_extension**: Value to use for the output's file extension.
5911 #### **Example**
5931 …me="var_output_name"></a>**output_name**: Define a name for the output file other than the default.
5950 #### **Example**
5957 …name="var_output_prefix_override"></a>**output_prefix_override**: Don't use prefix for output name.
5971 #### **Example**
5981 ### <a name="var_outputs"></a>**outputs**: Output files for actions and copy targets.
6004 …_partial_info_plist"></a>**partial_info_plist**: [filename] Path plist from asset catalog compiler.
6014 ### <a name="var_pool"></a>**pool**: Label of the pool used by the action.
6021 #### **Example**
6029 ### <a name="var_precompiled_header"></a>**precompiled_header**: [string] Header file to precompile.
6047 #### **GCC precompiled headers**
6058 #### **MSVC precompiled headers**
6097 ### <a name="var_precompiled_header_type"></a>**precompiled_header_type**: [string] "gcc" or "msvc".
6102 …<a name="var_precompiled_source"></a>**precompiled_source**: [file name] Source file to precompile.
6109 ### <a name="var_product_type"></a>**product_type**: Product type for Xcode projects.
6118 ### <a name="var_public"></a>**public**: Declare public header files for a target.
6161 #### **Examples**
6171 ### <a name="var_public_configs"></a>**public_configs**: Configs to be applied on dependents.
6184 #### **Propagation of public configs**
6223 #### **Avoiding applying public configs to this target**
6245 #### **Ordering of flags and values**
6262 ### <a name="var_public_deps"></a>**public_deps**: Declare public dependencies.
6284 #### **Discussion**
6299 #### **Example**
6313 ### <a name="var_rebase"></a>**rebase**: Rebase collected metadata as files.
6329 …ar_response_file_contents"></a>**response_file_contents**: Contents of a response file for actions.
6349 #### **Example**
6367 ### <a name="var_script"></a>**script**: Script file for actions.
6374 ### <a name="var_sources"></a>**sources**: Source files for a target
6381 #### **Sources for binary targets**
6402 #### **Sources for non-binary targets**
6416 ### <a name="var_swiftflags"></a>**swiftflags**: Flags passed to the swift compiler.
6425 #### **Ordering of flags and values**
6442 ### <a name="var_testonly"></a>**testonly**: Declares a target must only be used for testing.
6455 #### **Example**
6463 ### <a name="var_visibility"></a>**visibility**: A list of labels that can depend on a target.
6481 #### **Patterns**
6490 #### **Examples**
6518 ### <a name="var_walk_keys"></a>**walk_keys**: Key(s) for managing the metadata collection walk.
6532 …_weak_frameworks"></a>**weak_frameworks**: [name list] Name of frameworks that must be weak linked.
6545 #### **Ordering of flags and values**
6563 #### **Example**
6568 …write_runtime_deps"></a>**write_runtime_deps**: Writes the target's runtime_deps to the given path.
6588 …ame="var_xcasset_compiler_flags"></a>**xcasset_compiler_flags**: Flags passed to xcassets compiler.
6597 …code_extra_attributes"></a>**xcode_extra_attributes**: [scope] Extra attributes for Xcode projects.
6606 …="var_xcode_test_application_name"></a>**xcode_test_application_name**: Name for Xcode test target.
6616 #### **Example**
6626 ### <a name="buildargs"></a>**Build Arguments Overview**
6633 #### **How build arguments are set**
6662 #### **Examples**
6677 #### **How build arguments are used**
6690 ### <a name="dotfile"></a>**.gn file**
6707 #### **Variables**
6817 #### **Example .gn file contents**
6837 ### <a name="execution"></a>**Build graph and execution overview**
6839 #### **Overall build flow**
6867 #### **Executing target definitions and templates**
6894 #### **Which targets are built**
6909 #### **Dependencies**
6923 ### <a name="grammar"></a>**Language and grammar for GN build files**
6925 #### **Tokens**
6933 #### **White space and comments**
6945 #### **Identifiers**
6955 #### **Keywords**
6963 #### **Integer literals**
6973 #### **String literals**
7005 #### **Punctuation**
7016 #### **Grammar**
7053 #### **Types**
7075 #### **Lists**
7107 #### **Scopes**
7145 ### <a name="io_conversion"></a>**Input and output conversion**
7249 ### <a name="file_pattern"></a>**File patterns**
7268 #### **Pattern examples**
7283 ### <a name="label_pattern"></a>**Label patterns**
7319 ### <a name="labels"></a>**About labels**
7338 #### **Toolchains**
7351 #### **Relative labels**
7370 #### **Implicit names**
7379 ### <a name="metadata_collection"></a>**Metadata Collection**
7388 #### **generated_file targets**
7407 #### **Collection and Aggregation**
7506 #### **Common Uses**
7522 ### <a name="ninja_rules"></a>**Ninja build rules**
7524 #### **The "all" and "default" rules**
7535 #### **Phony rules**
7571 ### <a name="nogncheck"></a>**nogncheck**: Skip an include line from checking.
7601 #### **More information**
7608 ### <a name="runtime_deps"></a>**Runtime dependencies**
7622 #### **Executables**
7631 #### **Actions and copies**
7666 #### **Static libraries and source sets**
7677 #### **Multiple outputs**
7684 ### <a name="source_expansion"></a>**How Source Expansion Works**
7705 #### **Placeholders**
7760 #### **(*) Note on directories**
7776 #### **Examples**
7799 ### <a name="switch_list"></a>**Available global switches**