Skip to content

Commit f64ed4b

Browse files
committed
add versionadded, small doc updates
1 parent fdbf2a6 commit f64ed4b

File tree

3 files changed

+29
-24
lines changed

3 files changed

+29
-24
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,8 +78,8 @@ Unreleased changes template.
7878
* (sphinxdocs) Do not crash when `tag_class` does not have a populated `doc` value.
7979
Fixes ([#2579](https://github.com/bazelbuild/rules_python/issues/2579)).
8080
* (binaries/tests) Fix packaging when using `--bootstrap_impl=script`: set
81-
{obj}`--venvs_use_declare_symlink=no` to have it avoid creating symlinks at
82-
build time.
81+
{obj}`--venvs_use_declare_symlink=no` to have it not create symlinks at
82+
build time (they will be created at runtime instead).
8383
Fixes ([#2489](https://github.com/bazelbuild/rules_python/issues/2489)
8484

8585
{#v0-0-0-added}

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

Lines changed: 23 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -212,27 +212,6 @@ Values:
212212
:::
213213
::::
214214

215-
::::{bzl:flag} venvs_use_declare_symlink
216-
217-
Determines if relative symlinks are created using `declare_symlink()` at build
218-
time.
219-
220-
This is only intended to work around
221-
[#2489](https://github.com/bazelbuild/rules_python/issues/2489), where some
222-
packaging rules don't support `declare_symlink()` artifacts.
223-
224-
Values:
225-
* `yes`: Use `declare_symlink()` and create relative symlinks at build time.
226-
* `no`: Do not use `declare_symlink()`. Instead, the venv will be created at
227-
runtime.
228-
229-
:::{seealso}
230-
{envvar}`RULES_PYTHON_EXTRACT_ROOT` for customizing where the runtime venv
231-
is created.
232-
:::
233-
234-
:::{versionadded} VERSION_NEXT_PATCH
235-
:::
236215

237216
::::{bzl:flag} bootstrap_impl
238217
Determine how programs implement their startup process.
@@ -280,3 +259,26 @@ Values:
280259
:::
281260

282261
::::
262+
263+
::::{bzl:flag} venvs_use_declare_symlink
264+
265+
Determines if relative symlinks are created using `declare_symlink()` at build
266+
time.
267+
268+
This is only intended to work around
269+
[#2489](https://github.com/bazelbuild/rules_python/issues/2489), where some
270+
packaging rules don't support `declare_symlink()` artifacts.
271+
272+
Values:
273+
* `yes`: Use `declare_symlink()` and create relative symlinks at build time.
274+
* `no`: Do not use `declare_symlink()`. Instead, the venv will be created at
275+
runtime.
276+
277+
:::{seealso}
278+
{envvar}`RULES_PYTHON_EXTRACT_ROOT` for customizing where the runtime venv
279+
is created.
280+
:::
281+
282+
:::{versionadded} VERSION_NEXT_PATCH
283+
:::
284+
::::

docs/environment-variables.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ When `1`, the rules_python Starlark implementation of the core rules is used
2424
instead of the Bazel-builtin rules. Note this requires Bazel 7+.
2525
:::
2626

27-
:::{envvar} RULES_PYTHON_EXTRACT_ROOT
27+
::::{envvar} RULES_PYTHON_EXTRACT_ROOT
2828

2929
Directory to use as the root for creating files necessary for bootstrapping so
3030
that a binary can run.
@@ -43,7 +43,10 @@ being cleaned up by the OS.
4343

4444
If not set, then a temporary directory will be created and deleted upon program
4545
exit.
46+
47+
:::{versionadded} VERSION_NEXT_PATCH
4648
:::
49+
::::
4750

4851
:::{envvar} RULES_PYTHON_GAZELLE_VERBOSE
4952

0 commit comments

Comments
 (0)