rename to rules_python_extract_root

Author: rickeylev

docs/api/rules_python/python/config_settings/index.md

@@ -227,7 +227,7 @@ Values:
   runtime.
 
 :::{seealso}
-{envvar}`RULES_PYTHON_VENVS_ROOT` for customizing where the runtime venv
+{envvar}`RULES_PYTHON_EXTRACT_ROOT` for customizing where the runtime venv
 is created.
 :::
 

docs/environment-variables.md

@@ -69,13 +69,22 @@ When `1`, debug information about coverage behavior is printed to stderr.
 When `1`, debug information from gazelle is printed to stderr.
 :::
 
-:::{envvar} RULES_PYTHON_VENVS_ROOT
+:::{envvar} RULES_PYTHON_EXTRACT_ROOT
 
-Directory to use as the root for creating venvs for binaries. Only applicable
-when {obj}`--relative_venvs_symlinks=no` is used. A binary will attempt to
-find a unique, reusable, location for itself within this directory. When set,
-the created venv is not deleted upon program exit; it is the responsibility of
-the caller to manage cleanup.
+Directory to use as the root for creating files necessary for bootstrapping so
+that a binary can run.
+
+Only applicable when {obj}`--venvs_use_declare_symlink=no` is used.
+
+When set, a binary will attempt to find a unique, reusable, location within this
+directory for the files it needs to create to aid startup. The files may not be
+deleted upon program exit; it is the responsibility of the caller to ensure
+cleanup.
+
+Manually specifying the directory is useful to lower the overhead of
+extracting/creating files on every program execution. By using a location
+outside /tmp, longer lived programs don't have to worry about files in /tmp
+being cleaned up by the OS.
 
 If not set, then a temporary directory will be created and deleted upon program
 exit.

python/private/stage1_bootstrap_template.sh

@@ -132,12 +132,12 @@ if [[ "$IS_ZIPFILE" == "1" ]]; then
   mkdir -p "$(dirname $python_exe)"
   ln -s "$symlink_to" "$python_exe"
 elif [[ "$RECREATE_VENV_AT_RUNTIME" == "1" ]]; then
-  if [[ -n "$RULES_PYTHON_VENVS_ROOT" ]]; then
+  if [[ -n "$RULES_PYTHON_EXTRACT_ROOTT" ]]; then
     use_exec=1
     # Use our runfiles path as a unique, reusable, location for the
     # binary-specific venv being created.
-    venv="$RULES_PYTHON_VENVS_ROOT/$(dirname $(dirname $PYTHON_BINARY))"
-    mkdir -p $RULES_PYTHON_VENVS_ROOT
+    venv="$RULES_PYTHON_EXTRACT_ROOTT/$(dirname $(dirname $PYTHON_BINARY))"
+    mkdir -p $RULES_PYTHON_EXTRACT_ROOTT
   else
     # Re-exec'ing can't be used because we have to clean up the temporary
     # venv directory that is created.

tests/bootstrap_impls/run_binary_relative_venv_symlinks_no_test.sh

@@ -49,7 +49,7 @@ expect_match "sys.executable:.*tmp.*python3" "$actual"
 
 venvs_root=$(mkdir -d)
 
-actual=$(RULES_PYTHON_VENVS_ROOT=$venvs_root $bin)
+actual=$(RULES_PYTHON_EXTRACT_ROOT=$venvs_root $bin)
 expect_match "sys.executable:.*$venvs_root" "$actual"
 
 # Exit if any of the expects failed