A rule for building projects using the Ninja build tool
Rules
ninja
Rule for building external libraries with Ninja.
Example usage (generated)
load("@rules_foreign_cc//foreign_cc:ninja.bzl", "ninja")
ninja(
# A unique name for this target.
name = "",
# Label with source code to build
lib_source = "",
)
name
A unique name for this target.
additional_inputs
deprecated: Please use the build_data
attribute.
additional_tools
deprecated: Please use the build_data
attribute.
alwayslink
Optional. if true, link all the object files from the static library, even if they are not used.
args
A list of arguments to pass to the call to ninja
build_data
Files needed by this rule only during build/compile time. May list file or rule targets. Generally allows any target.
copts
Optional. 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.
data
Files needed by this rule at runtime. May list file or rule targets. Generally allows any target.
defines
Optional 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.
deps
Optional 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)
directory
A 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 set
env
Environment 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. No other macros are supported.Variables containing PATH
(e.g. PATH
, LD_LIBRARY_PATH
, CPATH
) entries will be prepended to the existing variable.
lib_name
Library 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.
lib_source
Label with source code to build. Typically a filegroup for the source of remote repository. Mandatory.
linkopts
Optional link options to be passed up to the dependencies of this library
out_bin_dir
Optional name of the output subdirectory with the binary files, defaults to 'bin'.
out_binaries
Optional names of the resulting binaries.
out_data_dirs
Optional names of additional directories created by the build that should be declared as bazel action outputs
out_headers_only
Flag variable to indicate that the library produces only headers
out_include_dir
Optional name of the output subdirectory with the header files, defaults to 'include'.
out_interface_libs
Optional names of the resulting interface libraries.
out_lib_dir
Optional name of the output subdirectory with the library files, defaults to 'lib'.
out_shared_libs
Optional names of the resulting shared libraries.
out_static_libs
Optional 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 assumed
postfix_script
Optional part of the shell script to be added after the make commands
targets
A 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 set
tool_prefix
A prefix for build commands
tools_deps
deprecated: Please use the build_data
attribute.