From 3ce88c99da54603c6838c9548c25dcee64cf522f Mon Sep 17 00:00:00 2001 From: Katrina Prosise Date: Wed, 11 Jun 2025 08:46:28 -0400 Subject: [PATCH] Reorder linux building guide Building with a Factory was moved ahead of building without. Other minor changes made to page. QA: Viewed rendered output, and edited with linter rules checked with an extension. No Issues. No related issue, minor fix following up on internal Slack discussion. Signed-off-by: Katrina Prosise --- .../lmp-customization/linux-building.rst | 100 +++++++++--------- 1 file changed, 52 insertions(+), 48 deletions(-) diff --git a/source/user-guide/lmp-customization/linux-building.rst b/source/user-guide/lmp-customization/linux-building.rst index 5d4fb84d..55dbdf93 100644 --- a/source/user-guide/lmp-customization/linux-building.rst +++ b/source/user-guide/lmp-customization/linux-building.rst @@ -30,8 +30,59 @@ Requirements * Minimum 50GB of storage for a complete LmP build * `Docker Installed`_. +Build and Install the LmP for your Factory +------------------------------------------ + +If you are already working with a Factory, you can download the source code with the following steps: + +1. Make and enter an installation directory for the LmP with your ````:: + + mkdir && cd + +2. Install the ```` meta-layers using repo: + + .. parsed-literal:: + + repo init -u https://source.foundries.io/factories//lmp-manifest.git -b main -m .xml + repo sync + + The manifest ``.xml`` refers to all the LmP meta-layers and also to the ```` specific repositories as described :ref:`ref-factory-sources`. + +3. Build the image for ```` with :term:`bitbake`: + + .. parsed-literal:: + + MACHINE= source setup-environment [BUILDDIR] + bitbake lmp-factory-image + + Set ``MACHINE`` to a supported machine. + See the current available options in :ref:`ref-linux-supported`. + + ``BUILDDIR`` is optional; the script defaults to ``build-lmp``. + + ``lmp-factory-image`` is the suggested default image. + Customize it with the steps from :ref:`ref-adding-packages-image`. + +.. tip:: + The ``bitbake`` step can take a while. + +Your build artifacts will be under ``deploy/images/``. +The artifact you use to flash your board is ``lmp-base-console-image-.wic.gz``. + +.. important:: + + While the local build is great for developing and debugging, + the image is not visible for the OTA system, and is for local use. + + When you push the changes to your Factory Git repos, it will trigger a new build. + You can then flash and register your device following the instructions of :ref:`gs-flash-device` and :ref:`gs-register`. + Then, you can take advantage of the OTA system. + +Build and Install Without a Factory +----------------------------------- + Setup ------- +^^^^^ #. Create local folders for ``sstate-cache``, ``downloads`` and ``build`` to save the build outside the container: @@ -114,53 +165,6 @@ Install the Image * For other targets, see :ref:`ref-linux-supported` for their instructions. -Build and Install the LmP for your Factory ------------------------------------------- - -If you are already working with a Factory, you can instead download the source code for that factory with the following steps. - -1. Make and enter an installation directory for the LmP using your ````:: - - mkdir && cd - -2. Install the ```` meta-layers using repo: - - .. parsed-literal:: - - repo init -u https://source.foundries.io/factories//lmp-manifest.git -b main -m .xml - repo sync - - The manifest ``.xml`` refers to all the LmP meta-layers and also to the ```` specific repositories as described :ref:`ref-factory-sources`. - -3. Build the image for ```` with :term:`bitbake`: - - .. parsed-literal:: - - MACHINE= source setup-environment [BUILDDIR] - bitbake lmp-factory-image - - Set ``MACHINE`` to a supported machine. - See the current available options in :ref:`ref-linux-supported`. - - ``BUILDDIR`` is optional; the script defaults to ``build-lmp``. - - ``lmp-factory-image`` is the suggested default image. - Customize it with the steps from :ref:`ref-adding-packages-image`. - -.. tip:: - The ``bitbake`` step can take a while. - -Your build artifacts will be under ``deploy/images/``. -The artifact you use to flash your board is ``lmp-base-console-image-.wic.gz``. - -.. important:: - - While the local build is great for developing and debugging, - the image is not visible for the OTA system, and is for local use. - - When you push the changes to your Factory Git repos, it will trigger a new build. - You can then flash and register your device following the instructions of :ref:`gs-flash-device` and :ref:`gs-register`. - Then, you can take advantage of the OTA system. .. _ref-linux-building-ref: