Skip to content

Commit e8e927b

Browse files
author
Jonathon Belotti
authoredMay 10, 2022
Add caveat about python_register_toolchain's hermeticty to README (#698)
* Add caveat about `python_register_toolchains` rule's hermeticity. * Fix typos and grammar
1 parent ed6bf15 commit e8e927b

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed
 

‎README.md

+8-3
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,9 @@ http_archive(
5454
)
5555
```
5656

57-
To register a hermetic Python toolchain rather than rely on whatever is already on the machine, you can add to the `WORKSPACE` file:
57+
### Toolchain registration
58+
59+
To register a hermetic Python toolchain rather than rely on a system-installed interpreter for runtime execution, you can add to the `WORKSPACE` file:
5860

5961
```python
6062
load("@rules_python//python:repositories.bzl", "python_register_toolchains")
@@ -77,8 +79,11 @@ pip_parse(
7779
)
7880
```
7981

80-
> You may find some quirks while using this toolchain.
81-
> Please refer to [this link](https://python-build-standalone.readthedocs.io/en/latest/quirks.html) for details.
82+
After registration, your Python targets will use the toolchain's interpreter during execution, but a system-installed interpreter
83+
is still used to 'bootstrap' Python targets (see https://github.com/bazelbuild/rules_python/issues/691).
84+
You may also find some quirks while using this toolchain. Please refer to [python-build-standalone documentation's _Quirks_ section](https://python-build-standalone.readthedocs.io/en/latest/quirks.html) for details.
85+
86+
### "Hello World"
8287

8388
Once you've imported the rule set into your `WORKSPACE` using any of these
8489
methods, you can then load the core rules in your `BUILD` files with:

0 commit comments

Comments
 (0)
Please sign in to comment.