cxx_toolchain

name

def name(
    *,
    name: str,
    default_target_platform: None | str = ...,
    target_compatible_with: list[str] = ...,
    compatible_with: list[str] = ...,
    exec_compatible_with: list[str] = ...,
    visibility: list[str] = ...,
    within_view: list[str] = ...,
    metadata: OpaqueMetadata = ...,
    tests: list[str] = ...,
    modifiers: OpaqueMetadata = ...,
    _apple_platforms: dict[str, str] = ...,
    _dumpbin_toolchain_path: None | str = ...,
    _msvc_hermetic_exec: str = ...,
    archive_contents: str = ...,
    archive_symbol_table: bool = ...,
    archiver: str,
    archiver_flags: list[str] = ...,
    archiver_reads_inputs: bool = ...,
    archiver_supports_argfiles: bool = ...,
    archiver_type: str,
    asm_compiler: None | str = ...,
    asm_compiler_flags: list[str] = ...,
    asm_compiler_type: None | str = ...,
    asm_preprocessor: None | str = ...,
    asm_preprocessor_flags: list[str] = ...,
    asm_preprocessor_type: None | str = ...,
    assembler: str,
    assembler_flags: list[str] = ...,
    assembler_preprocessor: None | str = ...,
    assembler_preprocessor_flags: list[str] = ...,
    assembler_preprocessor_type: None | str = ...,
    assembler_type: None | str = ...,
    binary_extension: None | str = ...,
    binary_linker_flags: list[str] = ...,
    bolt: None | str = ...,
    bolt_enabled: bool = ...,
    c_compiler: str,
    c_compiler_allow_cache_upload: None | bool = ...,
    c_compiler_flags: list[str] = ...,
    c_compiler_type: None | str = ...,
    c_preprocessor_flags: list[str] = ...,
    cache_links: bool = ...,
    clang_remarks: None | str = ...,
    clang_trace: None | bool = ...,
    compiler_type: None | str = ...,
    contacts: list[str] = ...,
    cpp_dep_tracking_mode: str = ...,
    cuda_compiler: None | str = ...,
    cuda_compiler_allow_cache_upload: None | bool = ...,
    cuda_compiler_flags: list[str] = ...,
    cuda_compiler_type: None | str = ...,
    cuda_dep_tracking_mode: str = ...,
    cuda_preprocessor_flags: list[str] = ...,
    custom_tools: dict[str, str] = ...,
    cvtres_compiler: None | str = ...,
    cvtres_compiler_flags: list[str] = ...,
    cvtres_compiler_type: None | str = ...,
    cvtres_preprocessor_flags: list[str] = ...,
    cxx_compiler: str,
    cxx_compiler_allow_cache_upload: None | bool = ...,
    cxx_compiler_flags: list[str] = ...,
    cxx_compiler_type: None | str = ...,
    cxx_preprocessor_flags: list[str] = ...,
    debug_path_prefix_map_sanitizer_format: None | str = ...,
    default_host_platform: None | str = ...,
    dist_thin_lto_codegen_flags: list[str] = ...,
    dwp: None | str = ...,
    executable_linker_flags: list[str] = ...,
    gcno_files: bool = ...,
    generate_linker_maps: bool = ...,
    headers_as_raw_headers_mode: None | str = ...,
    hip_compiler: None | str = ...,
    hip_compiler_flags: list[str] = ...,
    hip_compiler_type: None | str = ...,
    hip_preprocessor_flags: list[str] = ...,
    internal_tools: str = ...,
    labels: list[str] = ...,
    licenses: list[str] = ...,
    link_metadata_flag: None | str = ...,
    link_ordering: str = ...,
    link_style: str = ...,
    link_weight: int = ...,
    linker: str,
    linker_flags: list[str] = ...,
    linker_type: str,
    lipo: None | str = ...,
    llvm_link: None | str = ...,
    lto_mode: str = ...,
    min_sdk_version: None | str = ...,
    nm: str,
    objc_compiler_flags: list[str] = ...,
    objcopy_for_shared_library_interface: str,
    objcxx_compiler_flags: list[str] = ...,
    objdump: None | str = ...,
    object_file_extension: str = ...,
    object_format: str = ...,
    optimization_compiler_flags_EXPERIMENTAL: list[str] = ...,
    pic_behavior: str = ...,
    placeholder_tool: None | str = ...,
    platform_deps_aliases: None | list[str] = ...,
    platform_name: None | str = ...,
    post_linker_flags: list[str] = ...,
    private_headers_symlinks_enabled: bool = ...,
    public_headers_symlinks_enabled: bool = ...,
    ranlib: None | str = ...,
    ranlib_flags: list[str] = ...,
    raw_headers_as_headers_mode: None | str = ...,
    rc_compiler: None | str = ...,
    rc_compiler_flags: list[str] = ...,
    rc_compiler_type: None | str = ...,
    rc_preprocessor_flags: list[str] = ...,
    remap_cwd: bool = ...,
    requires_archives: bool = ...,
    requires_objects: bool = ...,
    sanitizer_runtime_enabled: bool = ...,
    sanitizer_runtime_files: list[str] = ...,
    shared_dep_runtime_ld_flags: list[str] = ...,
    shared_library_extension: str = ...,
    shared_library_interface_flags: list[str] = ...,
    shared_library_interface_mode: str = ...,
    shared_library_interface_producer: None | str = ...,
    shared_library_interface_type: str,
    shared_library_versioned_extension_format: str = ...,
    split_debug_mode: str = ...,
    static_dep_runtime_ld_flags: list[str] = ...,
    static_library_extension: str = ...,
    static_pic_dep_runtime_ld_flags: list[str] = ...,
    strip: str,
    strip_all_flags: None | list[str] = ...,
    strip_debug_flags: None | list[str] = ...,
    strip_non_global_flags: None | list[str] = ...,
    supports_distributed_thinlto: bool = ...,
    supports_two_phase_compilation: bool = ...,
    target_sdk_version: None | str = ...,
    thin_lto_premerger_enabled: bool = ...,
    use_archiver_flags: bool = ...,
    use_dep_files: None | bool = ...,
    use_header_map: bool = ...,
) -> None

Parameters

• name: name of the target
• default_target_platform: specifies the default target platform, used when no platforms are specified on the command line
• target_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
• compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with a configuration
• exec_compatible_with: a list of constraints that are required to be satisfied for this target to be compatible with an execution platform
• visibility: a list of visibility patterns restricting what targets can depend on this one
• within_view: a list of visibility patterns restricting what this target can depend on
• metadata: a key-value map of metadata associated with this target
• tests: a list of targets that provide tests for this one
• modifiers: an array of modifiers associated with this target
• binary_linker_flags: Linker flags that apply to all links coordinated by a binary rule. One key distinction between these and executable_linker_flags is that these will also apply to library links coordinated by binary rules (e.g. linking roots/deps when using native python or omnibus link strategies).
• c_compiler_allow_cache_upload: Whether to allow uploading of object files to cache when the compile action is executed locally and the configuration allows uploads (i.e., there is a cache configured and the client has permission to write to it).
• cuda_compiler_allow_cache_upload: Whether to allow uploading of object files to cache when the compile action is executed locally and the configuration allows uploads (i.e., there is a cache configured and the client has permission to write to it).
• cxx_compiler_allow_cache_upload: Whether to allow uploading of object files to cache when the compile action is executed locally and the configuration allows uploads (i.e., there is a cache configured and the client has permission to write to it).
• executable_linker_flags: Linker flags that only apply when linking an executable.
• link_style: The default value of the link_style attribute for rules that use this toolchain.
• raw_headers_as_headers_mode: Controls whether raw_headers and *include_directories attributes should be automatically converted to headers and symlink trees and/or header maps via headers. Only has an effect if the cxx_toolchain has explicitly opted into supporting this behavior via a non-default value, even if the value is disabled.