From af521b500b97b13223e95826c51bd7f3863aa3c6 Mon Sep 17 00:00:00 2001 From: UebelAndre Date: Sun, 8 Dec 2024 07:22:22 -0800 Subject: [PATCH] Regenerate documentation --- docs/src/cargo.md | 7 ++++--- docs/src/crate_universe.md | 10 ++++++---- docs/src/flatten.md | 7 ++++--- 3 files changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/src/cargo.md b/docs/src/cargo.md index b82f17dee2..cd55727f2d 100644 --- a/docs/src/cargo.md +++ b/docs/src/cargo.md @@ -32,9 +32,9 @@ A rule for generating variables for dependent `cargo_build_script`s without a bu 
 cargo_build_script(name, edition, crate_name, crate_root, srcs, crate_features, version, deps,
-                   link_deps, proc_macro_deps, build_script_env, data, compile_data, tools, links,
-                   rundir, rustc_env, rustc_env_files, rustc_flags, visibility, tags, aliases,
-                   pkg_name, kwargs)
+                   link_deps, proc_macro_deps, build_script_env, use_default_shell_env, data,
+                   compile_data, tools, links, rundir, rustc_env, rustc_env_files, rustc_flags,
+                   visibility, tags, aliases, pkg_name, kwargs)
Compile and execute a rust build script to generate build attributes @@ -111,6 +111,7 @@ The `hello_lib` target will be build with the flags and the environment variable | link_deps | The subset of the (normal) dependencies of the crate that have the links attribute and therefore provide environment variables to this build script. | `[]` | | proc_macro_deps | List of rust_proc_macro targets used to build the script. | `[]` | | build_script_env | Environment variables for build scripts. | `{}` | +| use_default_shell_env | Whether or not to include the default shell environment for the build script action. If unset the global setting `@rules_rust//cargo/settings:use_default_shell_env` will be used to determine this value. | `None` | | data | Files needed by the build script. | `[]` | | compile_data | Files needed for the compilation of the build script. | `[]` | | tools | Tools (executables) needed by the build script. | `[]` | diff --git a/docs/src/crate_universe.md b/docs/src/crate_universe.md index 11b7831c26..c83078dddc 100644 --- a/docs/src/crate_universe.md +++ b/docs/src/crate_universe.md @@ -474,10 +474,11 @@ crate.annotation(version, build_script_compile_data, build_script_data, build_script_tools, build_script_data_glob, build_script_deps, build_script_env, build_script_proc_macro_deps, build_script_rundir, build_script_rustc_env, - build_script_toolchains, compile_data, compile_data_glob, crate_features, data, - data_glob, deps, extra_aliased_targets, gen_binaries, disable_pipelining, - gen_build_script, patch_args, patch_tool, patches, proc_macro_deps, rustc_env, - rustc_env_files, rustc_flags, shallow_since, override_targets) + build_script_toolchains, build_script_use_default_shell_env, compile_data, + compile_data_glob, crate_features, data, data_glob, deps, extra_aliased_targets, + gen_binaries, disable_pipelining, gen_build_script, patch_args, patch_tool, patches, + proc_macro_deps, rustc_env, rustc_env_files, rustc_flags, shallow_since, + override_targets) A collection of extra attributes and settings for a particular crate @@ -501,6 +502,7 @@ A collection of extra attributes and settings for a particular crate | build_script_rundir | An override for the build script's rundir attribute. | `None` | | build_script_rustc_env | Additional environment variables to set on a crate's `cargo_build_script::env` attribute. | `None` | | build_script_toolchains | A list of labels to set on a crates's `cargo_build_script::toolchains` attribute. | `None` | +| build_script_use_default_shell_env | Whether or not to include the default shell environment for the build script action. | `None` | | compile_data | A list of labels to add to a crate's `rust_library::compile_data` attribute. | `None` | | compile_data_glob | A list of glob patterns to add to a crate's `rust_library::compile_data` attribute. | `None` | | crate_features | A list of strings to add to a crate's `rust_library::crate_features` attribute. | `None` | diff --git a/docs/src/flatten.md b/docs/src/flatten.md index 7171503d0d..88d5319777 100644 --- a/docs/src/flatten.md +++ b/docs/src/flatten.md @@ -1170,9 +1170,9 @@ A collection of files either found within the `rust-stdlib` artifact or generate 
 cargo_build_script(name, edition, crate_name, crate_root, srcs, crate_features, version, deps,
-                   link_deps, proc_macro_deps, build_script_env, data, compile_data, tools, links,
-                   rundir, rustc_env, rustc_env_files, rustc_flags, visibility, tags, aliases,
-                   pkg_name, kwargs)
+                   link_deps, proc_macro_deps, build_script_env, use_default_shell_env, data,
+                   compile_data, tools, links, rundir, rustc_env, rustc_env_files, rustc_flags,
+                   visibility, tags, aliases, pkg_name, kwargs)
Compile and execute a rust build script to generate build attributes @@ -1249,6 +1249,7 @@ The `hello_lib` target will be build with the flags and the environment variable | link_deps | The subset of the (normal) dependencies of the crate that have the links attribute and therefore provide environment variables to this build script. | `[]` | | proc_macro_deps | List of rust_proc_macro targets used to build the script. | `[]` | | build_script_env | Environment variables for build scripts. | `{}` | +| use_default_shell_env | Whether or not to include the default shell environment for the build script action. If unset the global setting `@rules_rust//cargo/settings:use_default_shell_env` will be used to determine this value. | `None` | | data | Files needed by the build script. | `[]` | | compile_data | Files needed for the compilation of the build script. | `[]` | | tools | Tools (executables) needed by the build script. | `[]` |