A rule for building projects using the Ninja build tool

ninja

ninja(name, additional_inputs, additional_tools, alwayslink, args, build_data, copts, data, defines,
      deps, directory, dynamic_deps, env, includes, lib_name, lib_source, linkopts, out_bin_dir,
      out_binaries, out_data_dirs, out_dll_dir, out_headers_only, out_include_dir, out_interface_libs,
      out_lib_dir, out_shared_libs, out_static_libs, postfix_script, set_file_prefix_map, targets,
      tool_prefix, tools_deps)

Rule for building external libraries with Ninja.

ATTRIBUTES

NameDescriptionTypeMandatoryDefault
nameA unique name for this target.Namerequired
additional_inputsdeprecated: Please use the build_data attribute.List of labelsoptional[]
additional_toolsdeprecated: Please use the build_data attribute.List of labelsoptional[]
alwayslinkOptional. if true, link all the object files from the static library, even if they are not used.BooleanoptionalFalse
argsA list of arguments to pass to the call to ninjaList of stringsoptional[]
build_dataFiles needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.List of labelsoptional[]
coptsOptional. Add these options to the compile flags passed to the foreign build system. The flags only take affect for compiling this target, not its dependencies.List of stringsoptional[]
dataFiles needed by this rule at runtime. May list file or rule targets. Generally allows any target.List of labelsoptional[]
definesOptional compilation definitions to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.List of stringsoptional[]
depsOptional dependencies to be copied into the directory structure. Typically those directly required for the external building of the library/binaries. (i.e. those that the external build system will be looking for and paths to which are provided by the calling rule)List of labelsoptional[]
directoryA directory to pass as the -C argument. The rule will always use the root directory of the lib_sources attribute if this attribute is not setStringoptional""
dynamic_depsSame as deps but for cc_shared_library.List of labelsoptional[]
envEnvironment variables to set during the build. $(execpath) macros may be used to point at files which are listed as data, deps, or build_data, but unlike with other rules, these will be replaced with absolute paths to those files, because the build does not run in the exec root. This attribute is subject to make variable substitution. No other macros are supported.Variables containing PATH (e.g. PATH, LD_LIBRARY_PATH, CPATH) entries will be prepended to the existing variable.Dictionary: String -> Stringoptional{}
includesOptional list of include dirs to be passed to the dependencies of this library. They are NOT passed to the compiler, you should duplicate them in the configuration options.List of stringsoptional[]
lib_nameLibrary name. Defines the name of the install directory and the name of the static library, if no output files parameters are defined (any of static_libraries, shared_libraries, interface_libraries, binaries_names) Optional. If not defined, defaults to the target's name.Stringoptional""
lib_sourceLabel with source code to build. Typically a filegroup for the source of remote repository. Mandatory.Labelrequired
linkoptsOptional link options to be passed up to the dependencies of this libraryList of stringsoptional[]
out_bin_dirOptional name of the output subdirectory with the binary files, defaults to 'bin'.Stringoptional"bin"
out_binariesOptional names of the resulting binaries.List of stringsoptional[]
out_data_dirsOptional names of additional directories created by the build that should be declared as bazel action outputsList of stringsoptional[]
out_dll_dirOptional name of the output subdirectory with the dll files, defaults to 'bin'.Stringoptional"bin"
out_headers_onlyFlag variable to indicate that the library produces only headersBooleanoptionalFalse
out_include_dirOptional name of the output subdirectory with the header files, defaults to 'include'.Stringoptional"include"
out_interface_libsOptional names of the resulting interface libraries.List of stringsoptional[]
out_lib_dirOptional name of the output subdirectory with the library files, defaults to 'lib'.Stringoptional"lib"
out_shared_libsOptional names of the resulting shared libraries.List of stringsoptional[]
out_static_libsOptional names of the resulting static libraries. Note that if out_headers_only, out_static_libs, out_shared_libs, and out_binaries are not set, default lib_name.a/lib_name.lib static library is assumedList of stringsoptional[]
postfix_scriptOptional part of the shell script to be added after the make commandsStringoptional""
set_file_prefix_mapUse -ffile-prefix-map with the intention to remove the sandbox path from debug symbolsBooleanoptionalFalse
targetsA list of targets with in the foreign build system to produce. An empty string ("") will result in a call to the underlying build system with no explicit target setList of stringsoptional[]
tool_prefixA prefix for build commandsStringoptional""
tools_depsdeprecated: Please use the build_data attribute.List of labelsoptional[]