Skip to content

Commit 4694963

Browse files
Geoffroy Van Cutsemdbkinder
authored andcommitted
Documentation: add 'make' to GSG and expand PATH for sphinx-build
Getting Started Guide: add one more bundle to be added on a Clear Linux development machine to make sure 'make' and other development packages are available. ACRN Documentation Generation: expand the 'PATH' variable to include '~/.local/bin' where 'sphinx-build' is installed. Tracked-On: #1650 Signed-off-by: Geoffroy Van Cutsem <geoffroy.vancutsem@intel.com>
1 parent 4b3b115 commit 4694963

File tree

2 files changed

+20
-6
lines changed

2 files changed

+20
-6
lines changed

doc/getting-started/apl-nuc.rst

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -416,14 +416,12 @@ each with their own way to install development tools:
416416
ACRN uses ``menuconfig``, a python3 text-based user interface (TUI) for
417417
configuring hypervisor options and using python's ``kconfiglib`` library.
418418

419-
* On a Clear Linux development system, install the ``os-clr-on-clr`` bundle to get
420-
the necessary tools:
419+
* On a Clear Linux development system, install the necessary tools:
421420

422421
.. code-block:: none
423422
424-
$ sudo swupd bundle-add os-clr-on-clr
425-
$ sudo swupd bundle-add python3-basic
426-
$ sudo pip3 install kconfiglib
423+
$ sudo swupd bundle-add os-clr-on-clr os-core-dev python3-basic
424+
$ pip3 install --user kconfiglib
427425
428426
* On a Ubuntu/Debian development system:
429427

doc/tutorials/docbuild.rst

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,9 @@ Our documentation processing has been tested to run with:
137137

138138
Depending on your Linux version, install the needed tools:
139139

140+
* For Clear Linux: follow the :ref:`getting-started-apl-nuc` to install
141+
all the tools required
142+
140143
* For Ubuntu use:
141144

142145
.. code-block:: bash
@@ -150,14 +153,27 @@ Depending on your Linux version, install the needed tools:
150153
151154
sudo dnf install doxygen python3-pip python3-wheel make graphviz
152155
153-
And for either Linux environment, install the remaining python-based
156+
And for any of these Linux environments, install the remaining python-based
154157
tools:
155158

156159
.. code-block:: bash
157160
158161
cd ~/projectacrn/acrn-hypervisor/doc
159162
pip3 install --user -r scripts/requirements.txt
160163
164+
Add ``$HOME/.local/bin`` to the front of your ``PATH`` so the system will
165+
find expected versions of python utilities such as ``sphinx-build`` and
166+
``breathe``:
167+
168+
.. code-block:: bash
169+
170+
printf "\nexport PATH=\$HOME/.local/bin:\$PATH" >> ~/.bashrc
171+
172+
.. note::
173+
174+
You will need to open a new terminal for this change to be effective.
175+
Adding this to your ``~/.bashrc`` file ensures it is set by default.
176+
161177
And with that you're ready to generate the documentation.
162178

163179
.. note::

0 commit comments

Comments
 (0)