Skip to content

Commit 38237af

Browse files
cshilwantStaticRocket
authored andcommitted
fix(linux): Update Yocto User Guide
* Replace opencl with zlib in bitbake examples, as opencl is no longer a valid recipe. Fixes [0] * Remove platform-specific ifconfig for SITARA and Jacinto since zlib is a common package available across all platforms * Convert example commands to use code-blocks directive [1] for improved readability and syntax highlighting [0] - #301 [1] - https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-code-block Signed-off-by: Chirag Shilwant <[email protected]>
1 parent 768ff06 commit 38237af

File tree

1 file changed

+36
-72
lines changed

1 file changed

+36
-72
lines changed

source/linux/Overview/_Processor_SDK_Building_The_SDK.rst

Lines changed: 36 additions & 72 deletions
Original file line numberDiff line numberDiff line change
@@ -305,10 +305,11 @@ In addition to individual components packages, the following table
305305
provides a list of build targets supported. These are the <target> used
306306
in the command:
307307

308-
``MACHINE=<machine> bitbake <target>``
308+
.. code-block:: console
309+
310+
MACHINE=<machine> bitbake <target>
309311
310-
The "Build Output" is given relative to the
311-
**deploy-ti** directory.
312+
The build system places the "Build Output" relative to :file:`deploy-ti`
312313

313314

314315
.. ifconfig:: CONFIG_sdk in ('SITARA')
@@ -724,7 +725,6 @@ The "Build Output" is given relative to the
724725
Recipes
725726
-------
726727

727-
728728
.. rubric:: Recipe Basics
729729
:name: Recipe Basics
730730

@@ -733,98 +733,62 @@ granularity of recipe development and debug. Specifying a recipe name,
733733
minus the version (if the version is appended to the name), will build
734734
the recipe and all its dependencies.
735735

736-
.. ifconfig:: CONFIG_sdk in ('SITARA')
737-
738-
For example, the command below builds only the opencl recipe and all the
739-
dependencies it defines.
740-
741-
``MACHINE=<machine> bitbake opencl``
742-
743-
After the bitbake command above is successfully done,
744-
:file:`arago-tmp-[toolchain]/work/<machine>-linux-gnueabi/opencl` directory
745-
will be available including the original source code under the git
746-
folder, independent shared objects (.so files) under packages-split
747-
folder, and IPKs under deploy-ipks folder.
736+
For example, the following command builds only the zlib recipe and all the
737+
dependencies it defines.
748738

749-
.. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
750-
751-
For example, the command below builds only the k3conf recipe and all the
752-
dependencies it defines.
739+
.. code-block:: console
753740
754-
``MACHINE=<machine> bitbake k3conf``
741+
MACHINE=<machine> bitbake zlib
755742
756-
After the bitbake command above is successfully done,
757-
**arago-tmp-[toolchain]/work/<machine>-linux/k3conf** directory
758-
will be available including the original source code under the git
759-
folder, independent shared objects (.so files) under packages-split
760-
folder, and IPKs under deploy-ipks folder.
743+
After the preceding bitbake command completes successfully, the
744+
:file:`arago-tmp-default-glibc/work/aarch64-oe-linux/zlib` directory gets created.
745+
It has the original source code, shared objects (.so files) in the packages-split folder
746+
and IPK packages in the deploy-ipks folder.
761747

762-
.. note:: Please note that the output of a recipe can be in another folder under "arago-tmp-[toolchain]/work" directory, depending on the defines of the recipe.
748+
.. note::
763749

750+
Please note that the output of a recipe can be in another folder under :file:`arago-tmp-[toolchain]/work` directory, depending on the defines of the recipe.
751+
You can call the following command from yocto's build directory to get the path to the workdir of your recipe.
752+
753+
.. code-block:: console
754+
755+
MACHINE=<machine> bitbake-getvar -r <recipe-name> WORKDIR --value
764756
765757
.. rubric:: Forced Re-compilation
766758
:name: Forced Re-compilation
767759

768-
.. ifconfig:: CONFIG_sdk in ('SITARA')
769-
770-
When needed, source code under the work directory (e.g.,
771-
**arago-tmp-[toolchain]/work/<machine>-linux-gnueabi/opencl**/git) can
772-
be modified. After the modification is done, run the following commands
773-
to force recompilation with the new code and rebuilding of the recipe,
774-
e.g.,
775-
``MACHINE=<machine> bitbake opencl --force -c compile``
760+
When needed, source code under the work directory (e.g.,
761+
:file:`arago-tmp-default-glibc/work/aarch64-oe-linux/zlib/<version>/zlib-<version>`) can
762+
be modified. After the modification is done, run the following commands
763+
to force recompilation with the new code and rebuilding of the recipe,
764+
For example,
776765

777-
``MACHINE=<machine> bitbake opencl``
778-
779-
.. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
780-
781-
When needed, source code under the work directory (e.g.,
782-
**arago-tmp-[toolchain]/work/<machine>-linux/k3conf**/git) can
783-
be modified. After the modification is done, run the following commands
784-
to force recompilation with the new code and rebuilding of the recipe,
785-
e.g.,
786-
787-
``MACHINE=<machine> bitbake k3conf --force -c compile``
766+
.. code-block:: console
788767
789-
``MACHINE=<machine> bitbake k3conf``
768+
MACHINE=<machine> bitbake zlib --force -c compile
769+
MACHINE=<machine> bitbake zlib
790770
791771
.. rubric:: Installing Package
792772
:name: installing-package
793773

794-
.. ifconfig:: CONFIG_sdk in ('SITARA')
795-
796-
To install a modified and rebuilt package, copy the new IPKs from the
797-
deploy-ipks folder (e.g.,
798-
**arago-tmp-[toolchain]/work/<machine>-linux-gnueabi/opencl/[version]/deploy-ipks**)
799-
to the target system and then run the following command to install the
800-
IPKs:
774+
To install a modified and rebuilt package, copy the new IPKs from the
775+
deploy-ipks folder (e.g., :file:`arago-tmp-default-glibc/work/aarch64-oe-linux/zlib/<version>/deploy-ipks`)
776+
to the target system and then run the following command to install the IPKs:
801777

802-
``opkg install [package_ipk].ipk``
803-
804-
.. ifconfig:: CONFIG_sdk in ('JACINTO','j7_foundational')
805-
806-
To install a modified and rebuilt package, copy the new IPKs from the
807-
deploy-ipks folder (e.g.,
808-
**arago-tmp-[toolchain]/work/<machine>-linux/k3conf/[version]/deploy-ipks**)
809-
to the target system and then run the following command to install the
810-
IPKs:
778+
.. code-block:: console
811779
812-
``opkg install [package_ipk].ipk``
780+
opkg install [package_ipk].ipk
813781
814782
.. rubric:: Cleaning a Built Recipe
815783
:name: cleaning-a-built-recipe
816784

817-
A built recipe can be cleaned using:
818-
819-
``MACHINE=<machine> bitbake <target> -c cleansstate``
785+
A built recipe can be entirely cleaned using:
820786

821-
or
787+
.. code-block:: console
822788
823-
``MACHINE=<machine> bitbake <target> -c cleanall``
789+
MACHINE=<machine> bitbake <target> -c cleanall
824790
825-
The cleansstate task will clean recipe's work directory and remove the
826-
recipe's output from the dependency tree used by other recipe's during
827-
compilation.
791+
The cleanall task removes all output files, shared state (sstate) cache and downloaded source files for a target (i.e. the contents of DL_DIR)
828792

829793
See also
830794
========

0 commit comments

Comments
 (0)