doc: notes for sdk installation in shared environments #81615
Conversation
cfriedt
force-pushed
the
doc-zephyr-setup-in-multi-user-environments
branch
from
6814414 to
b0697dd
Compare
cfriedt
changed the title
|
I guess there is some overlap / conflict with this https://docs.zephyrproject.org/latest/develop/toolchains/zephyr_sdk.html Maybe the only parts that are really relevant are the shared Python virtual environment and guidelines for building files for package managers (e.g. .deb or .rpm). |
doc/develop/beyond-GSG.rst
Outdated
| @@ -332,6 +332,75 @@ options. | |||
| This executable can be instrumented using standard tools, such as gdb or | |||
| valgrind. | |||
|
|
|||
| .. _gs_multi_user_environment: | |||
|
|
|||
| Zephyr SDK Installation in Multi-User Environments | |||
There was a problem hiding this comment.
Maybe "Shared" is a better choice of term than "Multi-User"?
| sudo mkdir -p /opt/zephyr/sdk/$VERSION | ||
| sudo chown $UID:$UID /opt/zephyr/sdk/$VERSION | ||
|
|
||
| 2. Create a shared Python virtual environment (in :ref:`this step <gs_python_deps>`) |
There was a problem hiding this comment.
I am not sure if it makes sense to tie Zephyr SDK and Python venv together given that venv is specific to Zephyr version, not SDK version.
If any, for a shared installation, the venv directory should be placed under a non-user directory that is specific to a Zephyr version, not SDK version.
There was a problem hiding this comment.
I was trying to force it to be tied to the SDK here, but you're right - it really isn't.
In practise, I just used a date for the version, but it should be tied to a Zephyr release (and maybe a patch version).
doc/develop/beyond-GSG.rst
Outdated
| @@ -401,6 +401,58 @@ Depending on the topology of build infrastructure, it may be preferable to simpl | |||
| the ``/opt/zephyr/sdk/$VERSION`` directory to neighboring build machines. Alternatively, use | |||
| ``/opt/zephyr/sdk/$VERSION`` to create packages using the package manager of choice. | |||
|
|
|||
| .. _gs_package_managers: | |||
|
|
|||
| Guidelines for Package Managers | |||
There was a problem hiding this comment.
This sounds more like it should be part of the SDK documentation -- at minimum, it should not be part of the "Getting Started Guide."
Add an anchor for installing the Zephyr SDK in the main page of the Getting Started Guide. Signed-off-by: Chris Friedt <[email protected]>
cfriedt
force-pushed
the
doc-zephyr-setup-in-multi-user-environments
branch
2 times, most recently
from
d2a53b3 to
8cc69b3
Compare
In the Beyond the Getting Started Guide page, add some notes for those who wish to install the Zephyr SDK and Python virtual environment in shared or distributed build environments. Signed-off-by: Chris Friedt <[email protected]>
Include notes in the Zephyr SDK doc for those who wish to build redistributable files for package managers (e.g. APT, RPM). This does not mean that Zephyr will be responsible for creating collections of .deb or .rpm packages for the Zephyr SDK. These are only some guidelines based on previous experience in that area. Signed-off-by: Chris Friedt <[email protected]>
cfriedt
force-pushed
the
doc-zephyr-setup-in-multi-user-environments
branch
from
8cc69b3 to
703fed9
Compare
cfriedt
changed the title
Doc Preview