Skip to content

Commit ca79d59

Browse files
authored
Documentation: Fix defaults on build_python.sh (project-chip#35901)
The default for the build environment shoudl be in the out dir since that's already excluded from git. Makes things easier for people following the documentation for the first time who won't necessarily change that directory to their preferred location.
1 parent aef88b6 commit ca79d59

File tree

4 files changed

+6
-5
lines changed

4 files changed

+6
-5
lines changed

docs/guides/python_chip_controller_building.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,8 @@ To build and run the Python CHIP controller:
7777
5. Build and install the Python CHIP controller:
7878
7979
```
80-
scripts/build_python.sh -m platform -i separate
80+
scripts/build_python.sh -m platform -i out/python_env
81+
source out/python_env/bin/activate
8182
```
8283
8384
> Note: This builds the Python CHIP Controller along with the CHIP REPL as

docs/testing/python.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -594,7 +594,7 @@ Next build the python wheels and create / activate a venv (called `pyenv` here,
594594
but any name may be used)
595595

596596
```
597-
./scripts/build_python.sh -i pyenv
597+
./scripts/build_python.sh -i out/python_env
598598
source pyenv/bin/activate
599599
```
600600

docs/testing/yaml.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -334,7 +334,7 @@ Next build the python wheels and create a venv (called `py` here, but any name
334334
may be used)
335335

336336
```
337-
./scripts/build_python.sh -i py
337+
./scripts/build_python.sh -i out/python_env
338338
source py/bin/activate
339339
```
340340

src/python_testing/post_certification_tests/production_device_checks.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@
3131
# files, then add the extra dependencies. From the root:
3232
#
3333
# . scripts/activate.sh
34-
# ./scripts/build_python.sh -i py
35-
# source py/bin/activate
34+
# ./scripts/build_python.sh -i out/python_env
35+
# source out/python_env/bin/activate
3636
# pip install opencv-python requests click_option_group
3737
# python src/python_testing/post_certification_tests/production_device_checks.py
3838

0 commit comments

Comments
 (0)