manuals: define proper numbered lists
PATCH 1/1 manuals: define proper numbered lists
From: Michael Opdenacker <[email protected]>
Using "#." instead of "1.", "2.", "3.", etc.
Signed-off-by Michael Opdenacker <[email protected]>
Reported-by Quentin Schulz <[email protected]>
--- documentation/dev-manual/bmaptool.rst | 6 +- documentation/dev-manual/building.rst | 46 ++++---- documentation/dev-manual/changes.rst | 48 ++++---- documentation/dev-manual/debugging.rst | 22 ++-- .../dev-manual/gobject-introspection.rst | 18 +-- documentation/dev-manual/layers.rst | 18 +-- documentation/dev-manual/packages.rst | 4 +- documentation/dev-manual/qemu.rst | 12 +- documentation/dev-manual/quilt.rst | 16 +-- documentation/dev-manual/runtime-testing.rst | 28 ++--- documentation/dev-manual/start.rst | 94 +++++++-------- .../dev-manual/upgrading-recipes.rst | 28 ++--- documentation/dev-manual/wayland.rst | 4 +- documentation/dev-manual/wic.rst | 8 +- documentation/kernel-dev/common.rst | 110 +++++++++--------- documentation/kernel-dev/intro.rst | 10 +- documentation/kernel-dev/maint-appx.rst | 16 +-- .../migration-guides/migration-general.rst | 14 +-- documentation/overview-manual/yp-intro.rst | 20 ++-- documentation/ref-manual/classes.rst | 4 +- .../ref-manual/system-requirements.rst | 20 ++-- documentation/ref-manual/variables.rst | 12 +- .../sdk-manual/appendix-customizing.rst | 14 +-- documentation/sdk-manual/appendix-obtain.rst | 28 ++--- documentation/sdk-manual/extensible.rst | 58 ++++----- documentation/sdk-manual/intro.rst | 6 +- documentation/sdk-manual/working-projects.rst | 22 ++-- documentation/toaster-manual/reference.rst | 8 +- 28 files changed, 347 insertions(+), 347 deletions(-)
documentation/dev-manual/bmaptool.rst +3 -3
@@ -28,18 +28,18 @@ Following, is an example that shows how to flash a Wic image. Realize that while this example uses a Wic image, you can use Bmaptool to flash any type of image. Use these steps to flash an image using Bmaptool: -1. *Update your local.conf File:* You need to have the following set +#. *Update your local.conf File:* You need to have the following set in your ``local.conf`` file before building your image:: IMAGE_FSTYPES += "wic wic.bmap" -2. *Get Your Image:* Either have your image ready (pre-built with the +#. *Get Your Image:* Either have your image ready (pre-built with the :term:`IMAGE_FSTYPES` setting previously mentioned) or take the step to build the image:: $ bitbake image -3. *Flash the Device:* Flash the device with the image by using Bmaptool +#. *Flash the Device:* Flash the device with the image by using Bmaptool depending on your particular setup. The following commands assume the image resides in the :term:`Build Directory`'s ``deploy/images/`` area:
documentation/dev-manual/building.rst +23 -23
162 lines not on this page · raw message
documentation/dev-manual/changes.rst +24 -24
145 lines not on this page · raw message
documentation/dev-manual/debugging.rst +11 -11
@@ -297,11 +297,11 @@ If you are unsure whether a variable dependency is being picked up automatically for a given task, you can list the variable dependencies BitBake has determined by doing the following: -1. Build the recipe containing the task:: +#. Build the recipe containing the task:: $ bitbake recipename -2. Inside the :term:`STAMPS_DIR` +#. Inside the :term:`STAMPS_DIR` directory, find the signature data (``sigdata``) file that corresponds to the task. The ``sigdata`` files contain a pickled Python database of all the metadata that went into creating the input
@@ -319,7 +319,7 @@ BitBake has determined by doing the following: the cached task output. The ``siginfo`` files contain exactly the same information as ``sigdata`` files. -3. Run ``bitbake-dumpsig`` on the ``sigdata`` or ``siginfo`` file. Here +#. Run ``bitbake-dumpsig`` on the ``sigdata`` or ``siginfo`` file. Here is an example:: $ bitbake-dumpsig ${BUILDDIR}/tmp/stamps/i586-poky-linux/db/6.0.30-r1.do_fetch.sigdata.7c048c18222b16ff0bcee2000ef648b1
@@ -992,7 +992,7 @@ site <https://sourceware.org/gdb/documentation/>`__. The following steps show you how to debug using the GNU project debugger. -1. *Configure your build system to construct the companion debug +#. *Configure your build system to construct the companion debug filesystem:* In your ``local.conf`` file, set the following::
@@ -1012,7 +1012,7 @@ debugger. the full filesystem for debugging. Subsequent steps in this procedure show how to combine the partial filesystem with the full filesystem. -2. *Configure the system to include gdbserver in the target filesystem:* +#. *Configure the system to include gdbserver in the target filesystem:* Make the following addition in your ``local.conf`` file::
@@ -1021,7 +1021,7 @@ debugger. The change makes sure the ``gdbserver`` package is included. -3. *Build the environment:* +#. *Build the environment:* Use the following command to construct the image and the companion Debug Filesystem::
@@ -1057,7 +1057,7 @@ debugger. the actual image (e.g. ``gdb-cross-i586``). The suggestion is usually the actual name you want to use. -4. *Set up the* ``debugfs``\ *:* +#. *Set up the* ``debugfs``\ *:* Run the following commands to set up the ``debugfs``::
@@ -1066,7 +1066,7 @@ debugger. $ tar xvfj build-dir/tmp/deploy/images/machine/image.rootfs.tar.bz2 $ tar xvfj build-dir/tmp/deploy/images/machine/image-dbg.rootfs.tar.bz2 -5. *Set up GDB:* +#. *Set up GDB:* Install the SDK (if you built one) and then source the correct environment file. Sourcing the environment file puts the SDK in your
@@ -1075,7 +1075,7 @@ debugger. If you are using the build system, Gdb is located in `build-dir`\ ``/tmp/sysroots/``\ `host`\ ``/usr/bin/``\ `architecture`\ ``/``\ `architecture`\ ``-gdb`` -6. *Boot the target:* +#. *Boot the target:* For information on how to run QEMU, see the `QEMU Documentation <https://wiki.qemu.org/Documentation/GettingStartedDevelopers>`__.
@@ -1084,7 +1084,7 @@ debugger. Be sure to verify that your host can access the target via TCP. -7. *Debug a program:* +#. *Debug a program:* Debugging a program involves running gdbserver on the target and then running Gdb on the host. The example in this step debugs ``gzip``:
@@ -1116,7 +1116,7 @@ debugger. users ``~/.gdbinit`` file. Upon starting, Gdb automatically runs whatever commands are in that file. -8. *Deploying without a full image rebuild:* +#. *Deploying without a full image rebuild:* In many cases, during development you want a quick method to deploy a new binary to the target and debug it, without waiting for a full
documentation/dev-manual/gobject-introspection.rst +9 -9
@@ -39,11 +39,11 @@ Enabling the Generation of Introspection Data Enabling the generation of introspection data (GIR files) in your library package involves the following: -1. Inherit the +#. Inherit the :ref:`gobject-introspection <ref-classes-gobject-introspection>` class. -2. Make sure introspection is not disabled anywhere in the recipe or +#. Make sure introspection is not disabled anywhere in the recipe or from anything the recipe includes. Also, make sure that "gobject-introspection-data" is not in :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
@@ -51,7 +51,7 @@ library package involves the following: :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. In either of these conditions, nothing will happen. -3. Try to build the recipe. If you encounter build errors that look like +#. Try to build the recipe. If you encounter build errors that look like something is unable to find ``.so`` libraries, check where these libraries are located in the source tree and add the following to the recipe::
@@ -63,7 +63,7 @@ library package involves the following: See recipes in the ``oe-core`` repository that use that :term:`GIR_EXTRA_LIBS_PATH` variable as an example. -4. Look for any other errors, which probably mean that introspection +#. Look for any other errors, which probably mean that introspection support in a package is not entirely standard, and thus breaks down in a cross-compilation environment. For such cases, custom-made fixes are needed. A good place to ask and receive help in these cases is
@@ -116,21 +116,21 @@ Testing that Introspection Works in an Image Use the following procedure to test if generating introspection data is working in an image: -1. Make sure that "gobject-introspection-data" is not in +#. Make sure that "gobject-introspection-data" is not in :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` and that "qemu-usermode" is not in :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. -2. Build ``core-image-sato``. +#. Build ``core-image-sato``. -3. Launch a Terminal and then start Python in the terminal. +#. Launch a Terminal and then start Python in the terminal. -4. Enter the following in the terminal:: +#. Enter the following in the terminal:: >>> from gi.repository import GLib >>> GLib.get_host_name() -5. For something a little more advanced, enter the following see: +#. For something a little more advanced, enter the following see: https://python-gtk-3-tutorial.readthedocs.io/en/latest/introduction.html Known Issues
documentation/dev-manual/layers.rst +9 -9
@@ -28,14 +28,14 @@ Creating Your Own Layer Follow these general steps to create your layer without using tools: -1. *Check Existing Layers:* Before creating a new layer, you should be +#. *Check Existing Layers:* Before creating a new layer, you should be sure someone has not already created a layer containing the Metadata you need. You can see the :oe_layerindex:`OpenEmbedded Metadata Index <>` for a list of layers from the OpenEmbedded community that can be used in the Yocto Project. You could find a layer that is identical or close to what you need. -2. *Create a Directory:* Create the directory for your layer. When you +#. *Create a Directory:* Create the directory for your layer. When you create the layer, be sure to create the directory in an area not associated with the Yocto Project :term:`Source Directory` (e.g. the cloned ``poky`` repository).
@@ -58,7 +58,7 @@ Follow these general steps to create your layer without using tools: "meta-" string are appended to several variables used in the configuration. -3. *Create a Layer Configuration File:* Inside your new layer folder, +#. *Create a Layer Configuration File:* Inside your new layer folder, you need to create a ``conf/layer.conf`` file. It is easiest to take an existing layer configuration file and copy that to your layer's ``conf`` directory and then modify the file as needed.
@@ -128,7 +128,7 @@ Follow these general steps to create your layer without using tools: variable is a good way to indicate if your particular layer is current. -4. *Add Content:* Depending on the type of layer, add the content. If +#. *Add Content:* Depending on the type of layer, add the content. If the layer adds support for a machine, add the machine configuration in a ``conf/machine/`` file within the layer. If the layer adds distro policy, add the distro configuration in a ``conf/distro/``
@@ -141,7 +141,7 @@ Follow these general steps to create your layer without using tools: Yocto Project, see the ":ref:`bsp-guide/bsp:example filesystem layout`" section in the Yocto Project Board Support Package (BSP) Developer's Guide. -5. *Optionally Test for Compatibility:* If you want permission to use +#. *Optionally Test for Compatibility:* If you want permission to use the Yocto Project Compatibility logo with your layer or application that uses your layer, perform the steps to apply for compatibility. See the
@@ -292,13 +292,13 @@ The Yocto Project Compatibility Program consists of a layer application process that requests permission to use the Yocto Project Compatibility Logo for your layer and application. The process consists of two parts: -1. Successfully passing a script (``yocto-check-layer``) that when run +#. Successfully passing a script (``yocto-check-layer``) that when run against your layer, tests it against constraints based on experiences of how layers have worked in the real world and where pitfalls have been found. Getting a "PASS" result from the script is required for successful compatibility registration. -2. Completion of an application acceptance form, which you can find at +#. Completion of an application acceptance form, which you can find at :yocto_home:`/webform/yocto-project-compatible-registration`. To be granted permission to use the logo, you need to satisfy the
@@ -870,10 +870,10 @@ checked out first), or into a completely independent location. The replication of the layers is performed by running the ``setup-layers`` script provided above: -1. Clone the bootstrap layer or some other repository to obtain +#. Clone the bootstrap layer or some other repository to obtain the json config and the setup script that can use it. -2. Run the script directly with no options:: +#. Run the script directly with no options:: alex@Zen2:/srv/work/alex/my-build$ meta-alex/setup-layers Note: not checking out source meta-alex, use --force-bootstraplayer-checkout to override.
documentation/dev-manual/packages.rst +2 -2
@@ -554,10 +554,10 @@ to use. In your configuration, you use the :term:`PACKAGE_CLASSES` variable to specify the format: -1. Open the ``local.conf`` file inside your :term:`Build Directory` (e.g. +#. Open the ``local.conf`` file inside your :term:`Build Directory` (e.g. ``poky/build/conf/local.conf``). -2. Select the desired package format as follows:: +#. Select the desired package format as follows:: PACKAGE_CLASSES ?= "package_packageformat"
documentation/dev-manual/qemu.rst +6 -6
@@ -44,13 +44,13 @@ To use QEMU, you need to have QEMU installed and initialized as well as have the proper artifacts (i.e. image files and root filesystems) available. Follow these general steps to run QEMU: -1. *Install QEMU:* QEMU is made available with the Yocto Project a +#. *Install QEMU:* QEMU is made available with the Yocto Project a number of ways. One method is to install a Software Development Kit (SDK). See ":ref:`sdk-manual/intro:the qemu emulator`" section in the Yocto Project Application Development and the Extensible Software Development Kit (eSDK) manual for information on how to install QEMU. -2. *Setting Up the Environment:* How you set up the QEMU environment +#. *Setting Up the Environment:* How you set up the QEMU environment depends on how you installed QEMU: - If you cloned the ``poky`` repository or you downloaded and
@@ -66,7 +66,7 @@ available. Follow these general steps to run QEMU: . poky_sdk/environment-setup-core2-64-poky-linux -3. *Ensure the Artifacts are in Place:* You need to be sure you have a +#. *Ensure the Artifacts are in Place:* You need to be sure you have a pre-built kernel that will boot in QEMU. You also need the target root filesystem for your target machine's architecture:
@@ -84,7 +84,7 @@ available. Follow these general steps to run QEMU: Extensible Software Development Kit (eSDK) manual for information on how to extract a root filesystem. -4. *Run QEMU:* The basic ``runqemu`` command syntax is as follows:: +#. *Run QEMU:* The basic ``runqemu`` command syntax is as follows:: $ runqemu [option ] [...]
@@ -184,7 +184,7 @@ the system does not need root privileges to run. It uses a user space NFS server to avoid that. Follow these steps to set up for running QEMU using an NFS server. -1. *Extract a Root Filesystem:* Once you are able to run QEMU in your +#. *Extract a Root Filesystem:* Once you are able to run QEMU in your environment, you can use the ``runqemu-extract-sdk`` script, which is located in the ``scripts`` directory along with the ``runqemu`` script.
@@ -198,7 +198,7 @@ using an NFS server. runqemu-extract-sdk ./tmp/deploy/images/qemux86-64/core-image-sato-qemux86-64.tar.bz2 test-nfs -2. *Start QEMU:* Once you have extracted the file system, you can run +#. *Start QEMU:* Once you have extracted the file system, you can run ``runqemu`` normally with the additional location of the file system. You can then also make changes to the files within ``./test-nfs`` and see those changes appear in the image in real time. Here is an
documentation/dev-manual/quilt.rst +8 -8
@@ -20,32 +20,32 @@ form of a patch all using Quilt. Follow these general steps: -1. *Find the Source Code:* Temporary source code used by the +#. *Find the Source Code:* Temporary source code used by the OpenEmbedded build system is kept in the :term:`Build Directory`. See the ":ref:`dev-manual/temporary-source-code:finding temporary source code`" section to learn how to locate the directory that has the temporary source code for a particular package. -2. *Change Your Working Directory:* You need to be in the directory that +#. *Change Your Working Directory:* You need to be in the directory that has the temporary source code. That directory is defined by the :term:`S` variable. -3. *Create a New Patch:* Before modifying source code, you need to +#. *Create a New Patch:* Before modifying source code, you need to create a new patch. To create a new patch file, use ``quilt new`` as below:: $ quilt new my_changes.patch -4. *Notify Quilt and Add Files:* After creating the patch, you need to +#. *Notify Quilt and Add Files:* After creating the patch, you need to notify Quilt about the files you plan to edit. You notify Quilt by adding the files to the patch you just created:: $ quilt add file1.c file2.c file3.c -5. *Edit the Files:* Make your changes in the source code to the files +#. *Edit the Files:* Make your changes in the source code to the files you added to the patch. -6. *Test Your Changes:* Once you have modified the source code, the +#. *Test Your Changes:* Once you have modified the source code, the easiest way to test your changes is by calling the :ref:`ref-tasks-compile` task as shown in the following example::
@@ -65,7 +65,7 @@ Follow these general steps: the ":ref:`dev-manual/disk-space:conserving disk space during builds`" section. -7. *Generate the Patch:* Once your changes work as expected, you need to +#. *Generate the Patch:* Once your changes work as expected, you need to use Quilt to generate the final patch that contains all your modifications::
@@ -78,7 +78,7 @@ Follow these general steps: You can find the resulting patch file in the ``patches/`` subdirectory of the source (:term:`S`) directory. -8. *Copy the Patch File:* For simplicity, copy the patch file into a +#. *Copy the Patch File:* For simplicity, copy the patch file into a directory named ``files``, which you can create in the same directory that holds the recipe (``.bb``) file or the append (``.bbappend``) file. Placing the patch here guarantees that the OpenEmbedded build
documentation/dev-manual/runtime-testing.rst +14 -14
@@ -84,25 +84,25 @@ In order to run tests, you need to do the following: Once you start running the tests, the following happens: -1. A copy of the root filesystem is written to ``${WORKDIR}/testimage``. +#. A copy of the root filesystem is written to ``${WORKDIR}/testimage``. -2. The image is booted under QEMU using the standard ``runqemu`` script. +#. The image is booted under QEMU using the standard ``runqemu`` script. -3. A default timeout of 500 seconds occurs to allow for the boot process +#. A default timeout of 500 seconds occurs to allow for the boot process to reach the login prompt. You can change the timeout period by setting :term:`TEST_QEMUBOOT_TIMEOUT` in the ``local.conf`` file. -4. Once the boot process is reached and the login prompt appears, the +#. Once the boot process is reached and the login prompt appears, the tests run. The full boot log is written to ``${WORKDIR}/testimage/qemu_boot_log``. -5. Each test module loads in the order found in :term:`TEST_SUITES`. You can +#. Each test module loads in the order found in :term:`TEST_SUITES`. You can find the full output of the commands run over SSH in ``${WORKDIR}/testimgage/ssh_target_log``. -6. If no failures occur, the task running the tests ends successfully. +#. If no failures occur, the task running the tests ends successfully. You can find the output from the ``unittest`` in the task log at ``${WORKDIR}/temp/log.do_testimage``.
@@ -117,13 +117,13 @@ For automated deployment, a "controller image" is installed onto the hardware once as part of setup. Then, each time tests are to be run, the following occurs: -1. The controller image is booted into and used to write the image to be +#. The controller image is booted into and used to write the image to be tested to a second partition. -2. The device is then rebooted using an external script that you need to +#. The device is then rebooted using an external script that you need to provide. -3. The device boots into the image to be tested. +#. The device boots into the image to be tested. When running tests (independent of whether the image has been deployed automatically or not), the device is expected to be connected to a
@@ -188,11 +188,11 @@ not need any information in this section. You can skip down to the If you did set :term:`TEST_TARGET` to "SystemdbootTarget", you also need to perform a one-time setup of your controller image by doing the following: -1. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: +#. *Set EFI_PROVIDER:* Be sure that :term:`EFI_PROVIDER` is as follows:: EFI_PROVIDER = "systemd-boot" -2. *Build the controller image:* Build the ``core-image-testmaster`` image. +#. *Build the controller image:* Build the ``core-image-testmaster`` image. The ``core-image-testmaster`` recipe is provided as an example for a "controller" image and you can customize the image recipe as you would any other recipe.
@@ -219,13 +219,13 @@ perform a one-time setup of your controller image by doing the following: - Another partition labeled "testrootfs" where test images get deployed. -3. *Install image:* Install the image that you just built on the target +#. *Install image:* Install the image that you just built on the target system. The final thing you need to do when setting :term:`TEST_TARGET` to "SystemdbootTarget" is to set up the test image: -1. *Set up your local.conf file:* Make sure you have the following +#. *Set up your local.conf file:* Make sure you have the following statements in your ``local.conf`` file:: IMAGE_FSTYPES += "tar.gz"
@@ -233,7 +233,7 @@ The final thing you need to do when setting :term:`TEST_TARGET` to TEST_TARGET = "SystemdbootTarget" TEST_TARGET_IP = "192.168.2.3" -2. *Build your test image:* Use BitBake to build the image:: +#. *Build your test image:* Use BitBake to build the image:: $ bitbake core-image-sato
documentation/dev-manual/start.rst +47 -47
325 lines not on this page · raw message
documentation/dev-manual/upgrading-recipes.rst +14 -14
@@ -51,12 +51,12 @@ commit messages in the layer's tree for the changes made to recipes. The following steps describe how to set up the AUH utility: -1. *Be Sure the Development Host is Set Up:* You need to be sure that +#. *Be Sure the Development Host is Set Up:* You need to be sure that your development host is set up to use the Yocto Project. For information on how to set up your host, see the ":ref:`dev-manual/start:Preparing the Build Host`" section. -2. *Make Sure Git is Configured:* The AUH utility requires Git to be +#. *Make Sure Git is Configured:* The AUH utility requires Git to be configured because AUH uses Git to save upgrades. Thus, you must have Git user and email configured. The following command shows your configurations::
@@ -69,7 +69,7 @@ The following steps describe how to set up the AUH utility: $ git config --global user.name some_name $ git config --global user.email [email protected] -3. *Clone the AUH Repository:* To use AUH, you must clone the repository +#. *Clone the AUH Repository:* To use AUH, you must clone the repository onto your development host. The following command uses Git to create a local copy of the repository on your system::
@@ -84,7 +84,7 @@ The following steps describe how to set up the AUH utility: AUH is not part of the :term:`OpenEmbedded-Core (OE-Core)` or :term:`Poky` repositories. -4. *Create a Dedicated Build Directory:* Run the :ref:`structure-core-script` +#. *Create a Dedicated Build Directory:* Run the :ref:`structure-core-script` script to create a fresh :term:`Build Directory` that you use exclusively for running the AUH utility::
@@ -95,7 +95,7 @@ The following steps describe how to set up the AUH utility: recommended as existing settings could cause AUH to fail or behave undesirably. -5. *Make Configurations in Your Local Configuration File:* Several +#. *Make Configurations in Your Local Configuration File:* Several settings are needed in the ``local.conf`` file in the build directory you just created for AUH. Make these following configurations:
@@ -128,13 +128,13 @@ The following steps describe how to set up the AUH utility: DISTRO_FEATURES:append = " ptest" -6. *Optionally Start a vncserver:* If you are running in a server +#. *Optionally Start a vncserver:* If you are running in a server without an X11 session, you need to start a vncserver:: $ vncserver :1 $ export DISPLAY=:1 -7. *Create and Edit an AUH Configuration File:* You need to have the +#. *Create and Edit an AUH Configuration File:* You need to have the ``upgrade-helper/upgrade-helper.conf`` configuration file in your :term:`Build Directory`. You can find a sample configuration file in the :yocto_git:`AUH source repository </auto-upgrade-helper/tree/>`.
@@ -346,17 +346,17 @@ you can manually edit the recipe files to upgrade the versions. To manually upgrade recipe versions, follow these general steps: -1. *Change the Version:* Rename the recipe such that the version (i.e. +#. *Change the Version:* Rename the recipe such that the version (i.e. the :term:`PV` part of the recipe name) changes appropriately. If the version is not part of the recipe name, change the value as it is set for :term:`PV` within the recipe itself. -2. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds +#. *Update* :term:`SRCREV` *if Needed*: If the source code your recipe builds is fetched from Git or some other version control system, update :term:`SRCREV` to point to the commit hash that matches the new version. -3. *Build the Software:* Try to build the recipe using BitBake. Typical +#. *Build the Software:* Try to build the recipe using BitBake. Typical build failures include the following: - License statements were updated for the new version. For this
@@ -377,22 +377,22 @@ To manually upgrade recipe versions, follow these general steps: issues. If a patch is necessary and failing, you need to rebase it into the new version. -4. *Optionally Attempt to Build for Several Architectures:* Once you +#. *Optionally Attempt to Build for Several Architectures:* Once you successfully build the new software for a given architecture, you could test the build for other architectures by changing the :term:`MACHINE` variable and rebuilding the software. This optional step is especially important if the recipe is to be released publicly. -5. *Check the Upstream Change Log or Release Notes:* Checking both these +#. *Check the Upstream Change Log or Release Notes:* Checking both these reveals if there are new features that could break backwards-compatibility. If so, you need to take steps to mitigate or eliminate that situation. -6. *Optionally Create a Bootable Image and Test:* If you want, you can +#. *Optionally Create a Bootable Image and Test:* If you want, you can test the new software by booting it onto actual hardware. -7. *Create a Commit with the Change in the Layer Repository:* After all +#. *Create a Commit with the Change in the Layer Repository:* After all builds work and any testing is successful, you can create commits for any changes in the layer holding your upgraded recipe.
documentation/dev-manual/wayland.rst +2 -2
@@ -78,13 +78,13 @@ Alternatively, you can run Weston through the command-line interpretor (CLI), which is better suited for development work. To run Weston under the CLI, you need to do the following after your image is built: -1. Run these commands to export ``XDG_RUNTIME_DIR``:: +#. Run these commands to export ``XDG_RUNTIME_DIR``:: mkdir -p /tmp/$USER-weston chmod 0700 /tmp/$USER-weston export XDG_RUNTIME_DIR=/tmp/$USER-weston -2. Launch Weston in the shell:: +#. Launch Weston in the shell:: weston
documentation/dev-manual/wic.rst +4 -4
@@ -641,7 +641,7 @@ modify the kernel. The following example examines the contents of the Wic image, deletes the existing kernel, and then inserts a new kernel: -1. *List the Partitions:* Use the ``wic ls`` command to list all the +#. *List the Partitions:* Use the ``wic ls`` command to list all the partitions in the Wic image:: $ wic ls tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic
@@ -652,7 +652,7 @@ the existing kernel, and then inserts a new kernel: The previous output shows two partitions in the ``core-image-minimal-qemux86.wic`` image. -2. *Examine a Particular Partition:* Use the ``wic ls`` command again +#. *Examine a Particular Partition:* Use the ``wic ls`` command again but in a different form to examine a particular partition. .. note::
@@ -700,12 +700,12 @@ the existing kernel, and then inserts a new kernel: Add mtools_skip_check=1 to your .mtoolsrc file to skip this test -3. *Remove the Old Kernel:* Use the ``wic rm`` command to remove the +#. *Remove the Old Kernel:* Use the ``wic rm`` command to remove the ``vmlinuz`` file (kernel):: $ wic rm tmp/deploy/images/qemux86/core-image-minimal-qemux86.wic:1/vmlinuz -4. *Add In the New Kernel:* Use the ``wic cp`` command to add the +#. *Add In the New Kernel:* Use the ``wic cp`` command to add the updated kernel to the Wic image. Depending on how you built your kernel, it could be in different places. If you used ``devtool`` and an SDK to build your kernel, it resides in the ``tmp/work`` directory
documentation/kernel-dev/common.rst +55 -55
416 lines not on this page · raw message
documentation/kernel-dev/intro.rst +5 -5
@@ -108,12 +108,12 @@ general information and references for further information. .. image:: figures/kernel-dev-flow.png :width: 100% -1. *Set up Your Host Development System to Support Development Using the +#. *Set up Your Host Development System to Support Development Using the Yocto Project*: See the ":doc:`/dev-manual/start`" section in the Yocto Project Development Tasks Manual for options on how to get a build host ready to use the Yocto Project. -2. *Set Up Your Host Development System for Kernel Development:* It is +#. *Set Up Your Host Development System for Kernel Development:* It is recommended that you use ``devtool`` for kernel development. Alternatively, you can use traditional kernel development methods with the Yocto Project. Either way, there are
@@ -131,7 +131,7 @@ general information and references for further information. ":ref:`kernel-dev/common:getting ready for traditional kernel development`" section. -3. *Make Changes to the Kernel Source Code if applicable:* Modifying the +#. *Make Changes to the Kernel Source Code if applicable:* Modifying the kernel does not always mean directly changing source files. However, if you have to do this, you make the changes to the files in the Yocto's :term:`Build Directory` if you are using ``devtool``. For more
@@ -144,7 +144,7 @@ general information and references for further information. ":ref:`kernel-dev/common:using traditional kernel development to patch the kernel`" section. -4. *Make Kernel Configuration Changes if Applicable:* If your situation +#. *Make Kernel Configuration Changes if Applicable:* If your situation calls for changing the kernel's configuration, you can use :ref:`menuconfig <kernel-dev/common:using \`\`menuconfig\`\`>`, which allows you to
@@ -169,7 +169,7 @@ general information and references for further information. Additionally, if you are working in a BSP layer and need to modify the BSP's kernel's configuration, you can use ``menuconfig``. -5. *Rebuild the Kernel Image With Your Changes:* Rebuilding the kernel +#. *Rebuild the Kernel Image With Your Changes:* Rebuilding the kernel image applies your changes. Depending on your target hardware, you can verify your changes on actual hardware or perhaps QEMU.
documentation/kernel-dev/maint-appx.rst +8 -8
@@ -92,11 +92,11 @@ top-level kernel feature or BSP. The following actions effectively provide the Metadata and create the tree that includes the new feature, patch, or BSP: -1. *Pass Feature to the OpenEmbedded Build System:* A top-level kernel +#. *Pass Feature to the OpenEmbedded Build System:* A top-level kernel feature is passed to the kernel build subsystem. Normally, this feature is a BSP for a particular kernel type. -2. *Locate Feature:* The file that describes the top-level feature is +#. *Locate Feature:* The file that describes the top-level feature is located by searching these system directories: - The in-tree kernel-cache directories, which are located in the
@@ -112,31 +112,31 @@ patch, or BSP: bsp_root_name-kernel_type.scc -3. *Expand Feature:* Once located, the feature description is either +#. *Expand Feature:* Once located, the feature description is either expanded into a simple script of actions, or into an existing equivalent script that is already part of the shipped kernel. -4. *Append Extra Features:* Extra features are appended to the top-level +#. *Append Extra Features:* Extra features are appended to the top-level feature description. These features can come from the :term:`KERNEL_FEATURES` variable in recipes. -5. *Locate, Expand, and Append Each Feature:* Each extra feature is +#. *Locate, Expand, and Append Each Feature:* Each extra feature is located, expanded and appended to the script as described in step three. -6. *Execute the Script:* The script is executed to produce files +#. *Execute the Script:* The script is executed to produce files ``.scc`` and ``.cfg`` files in appropriate directories of the ``yocto-kernel-cache`` repository. These files are descriptions of all the branches, tags, patches and configurations that need to be applied to the base Git repository to completely create the source (build) branch for the new BSP or feature. -7. *Clone Base Repository:* The base repository is cloned, and the +#. *Clone Base Repository:* The base repository is cloned, and the actions listed in the ``yocto-kernel-cache`` directories are applied to the tree. -8. *Perform Cleanup:* The Git repositories are left with the desired +#. *Perform Cleanup:* The Git repositories are left with the desired branches checked out and any required branching, patching and tagging has been performed.
documentation/migration-guides/migration-general.rst +7 -7
@@ -81,11 +81,11 @@ any new Yocto Project release. the migration (e.g. added/removed packages, added/removed files, size changes etc.). To do this, follow these steps: - 1. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration + #. Enable :ref:`buildhistory <ref-classes-buildhistory>` before the migration - 2. Run a pre-migration build + #. Run a pre-migration build - 3. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as + #. Capture the :ref:`buildhistory <ref-classes-buildhistory>` output (as specified by :term:`BUILDHISTORY_DIR`) and ensure it is preserved for subsequent builds. How you would do this depends on how you are running your builds - if you are doing this all on one workstation in the same
@@ -93,15 +93,15 @@ any new Yocto Project release. deleting the :ref:`buildhistory <ref-classes-buildhistory>` output directory. For builds in a pipeline it may be more complicated. - 4. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before + #. Set a tag in the :ref:`buildhistory <ref-classes-buildhistory>` output (which is a git repository) before migration, to make the commit from the pre-migration build easy to find as you may end up running multiple builds during the migration. - 5. Perform the migration + #. Perform the migration - 6. Run a build + #. Run a build - 7. Check the output changes between the previously set tag and HEAD in the + #. Check the output changes between the previously set tag and HEAD in the :ref:`buildhistory <ref-classes-buildhistory>` output using ``git diff`` or ``buildhistory-diff``. For more information on using :ref:`buildhistory <ref-classes-buildhistory>`, see
documentation/overview-manual/yp-intro.rst +10 -10
@@ -517,18 +517,18 @@ Historically, the Build Appliance was the second of three methods by which you could use the Yocto Project on a system that was not native to Linux. -1. *Hob:* Hob, which is now deprecated and is no longer available since +#. *Hob:* Hob, which is now deprecated and is no longer available since the 2.1 release of the Yocto Project provided a rudimentary, GUI-based interface to the Yocto Project. Toaster has fully replaced Hob. -2. *Build Appliance:* Post Hob, the Build Appliance became available. It +#. *Build Appliance:* Post Hob, the Build Appliance became available. It was never recommended that you use the Build Appliance as a day-to-day production development environment with the Yocto Project. Build Appliance was useful as a way to try out development in the Yocto Project environment. -3. *CROPS:* The final and best solution available now for developing +#. *CROPS:* The final and best solution available now for developing using the Yocto Project on a system not native to Linux is with :ref:`CROPS <overview-manual/yp-intro:development tools>`.
@@ -719,27 +719,27 @@ workflow: Following is a brief summary of the "workflow": -1. Developers specify architecture, policies, patches and configuration +#. Developers specify architecture, policies, patches and configuration details. -2. The build system fetches and downloads the source code from the +#. The build system fetches and downloads the source code from the specified location. The build system supports standard methods such as tarballs or source code repositories systems such as Git. -3. Once source code is downloaded, the build system extracts the sources +#. Once source code is downloaded, the build system extracts the sources into a local work area where patches are applied and common steps for configuring and compiling the software are run. -4. The build system then installs the software into a temporary staging +#. The build system then installs the software into a temporary staging area where the binary package format you select (DEB, RPM, or IPK) is used to roll up the software. -5. Different QA and sanity checks run throughout entire build process. +#. Different QA and sanity checks run throughout entire build process. -6. After the binaries are created, the build system generates a binary +#. After the binaries are created, the build system generates a binary package feed that is used to create the final root file image. -7. The build system generates the file system image and a customized +#. The build system generates the file system image and a customized Extensible SDK (eSDK) for application development in parallel. For a very detailed look at this workflow, see the
documentation/ref-manual/classes.rst +2 -2
@@ -979,11 +979,11 @@ by default (as specified by :term:`IMAGE_BUILDINFO_FILE`). This can be useful for manually determining the origin of any given image. It writes out two sections: -1. `Build Configuration`: a list of variables and their values (specified +#. `Build Configuration`: a list of variables and their values (specified by :term:`IMAGE_BUILDINFO_VARS`, which defaults to :term:`DISTRO` and :term:`DISTRO_VERSION`) -2. `Layer Revisions`: the revisions of all of the layers used in the +#. `Layer Revisions`: the revisions of all of the layers used in the build. Additionally, when building an SDK it will write the same contents
documentation/ref-manual/system-requirements.rst +10 -10
@@ -235,7 +235,7 @@ The ``install-buildtools`` script is the easiest of the three methods by which you can get these tools. It downloads a pre-built buildtools installer and automatically installs the tools for you: -1. Execute the ``install-buildtools`` script. Here is an example:: +#. Execute the ``install-buildtools`` script. Here is an example:: $ cd poky $ scripts/install-buildtools \
@@ -268,7 +268,7 @@ installer and automatically installs the tools for you: $ cd poky $ scripts/install-buildtools --make-only -2. Source the tools environment setup script by using a command like the +#. Source the tools environment setup script by using a command like the following:: $ source /path/to/poky/buildtools/environment-setup-x86_64-pokysdk-linux
@@ -291,9 +291,9 @@ If you would prefer not to use the ``install-buildtools`` script, you can instea download and run a pre-built buildtools installer yourself with the following steps: -1. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` +#. Locate and download the ``*.sh`` at :yocto_dl:`/releases/yocto/yocto-&DISTRO;/buildtools/` -2. Execute the installation script. Here is an example for the +#. Execute the installation script. Here is an example for the traditional installer:: $ sh ~/Downloads/x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
@@ -310,7 +310,7 @@ steps: installation directory. For example, you could choose the following: ``/home/your-username/buildtools`` -3. Source the tools environment setup script by using a command like the +#. Source the tools environment setup script by using a command like the following:: $ source /home/your_username/buildtools/environment-setup-i586-poky-linux
@@ -339,11 +339,11 @@ Python (or gcc) requirements. Here are the steps to take to build and run your own buildtools installer: -1. On the machine that is able to run BitBake, be sure you have set up +#. On the machine that is able to run BitBake, be sure you have set up your build environment with the setup script (:ref:`structure-core-script`). -2. Run the BitBake command to build the tarball:: +#. Run the BitBake command to build the tarball:: $ bitbake buildtools-tarball
@@ -365,10 +365,10 @@ installer: :term:`Build Directory`. The installer file has the string "buildtools" (or "buildtools-extended") in the name. -3. Transfer the ``.sh`` file from the build host to the machine that +#. Transfer the ``.sh`` file from the build host to the machine that does not meet the Git, tar, or Python (or gcc) requirements. -4. On the machine that does not meet the requirements, run the ``.sh`` +#. On the machine that does not meet the requirements, run the ``.sh`` file to install the tools. Here is an example for the traditional installer::
@@ -386,7 +386,7 @@ installer: installation directory. For example, you could choose the following: ``/home/your_username/buildtools`` -5. Source the tools environment setup script by using a command like the +#. Source the tools environment setup script by using a command like the following:: $ source /home/your_username/buildtools/environment-setup-x86_64-poky-linux
documentation/ref-manual/variables.rst +6 -6
@@ -5868,25 +5868,25 @@ system and gives an overview of their function and contents. omit any argument you like but must retain the separating commas. The order is important and specifies the following: - 1. Extra arguments that should be added to the configure script + #. Extra arguments that should be added to the configure script argument list (:term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS`) if the feature is enabled. - 2. Extra arguments that should be added to :term:`EXTRA_OECONF` or + #. Extra arguments that should be added to :term:`EXTRA_OECONF` or :term:`PACKAGECONFIG_CONFARGS` if the feature is disabled. - 3. Additional build dependencies (:term:`DEPENDS`) + #. Additional build dependencies (:term:`DEPENDS`) that should be added if the feature is enabled. - 4. Additional runtime dependencies (:term:`RDEPENDS`) + #. Additional runtime dependencies (:term:`RDEPENDS`) that should be added if the feature is enabled. - 5. Additional runtime recommendations + #. Additional runtime recommendations (:term:`RRECOMMENDS`) that should be added if the feature is enabled. - 6. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` + #. Any conflicting (that is, mutually exclusive) :term:`PACKAGECONFIG` settings for this feature. Consider the following :term:`PACKAGECONFIG` block taken from the
documentation/sdk-manual/appendix-customizing.rst +7 -7
@@ -173,12 +173,12 @@ perform additional steps. These steps make it possible for anyone using the installed SDKs to update the installed SDKs by using the ``devtool sdk-update`` command: -1. Create a directory that can be shared over HTTP or HTTPS. You can do +#. Create a directory that can be shared over HTTP or HTTPS. You can do this by setting up a web server such as an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server in the cloud to host the directory. This directory must contain the published SDK. -2. Set the +#. Set the :term:`SDK_UPDATE_URL` variable to point to the corresponding HTTP or HTTPS URL. Setting this variable causes any SDK built to default to that URL and thus,
@@ -187,10 +187,10 @@ the installed SDKs to update the installed SDKs by using the ":ref:`sdk-manual/extensible:applying updates to an installed extensible sdk`" section. -3. Build the extensible SDK normally (i.e., use the +#. Build the extensible SDK normally (i.e., use the ``bitbake -c populate_sdk_ext`` imagename command). -4. Publish the SDK using the following command:: +#. Publish the SDK using the following command:: $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory
@@ -245,7 +245,7 @@ If you want the users of an extensible SDK you build to be able to add items to the SDK without requiring the users to build the items from source, you need to do a number of things: -1. Ensure the additional items you want the user to be able to install +#. Ensure the additional items you want the user to be able to install are already built: - Build the items explicitly. You could use one or more "meta"
@@ -257,12 +257,12 @@ source, you need to do a number of things: :term:`EXCLUDE_FROM_WORLD` variable for additional information. -2. Expose the ``sstate-cache`` directory produced by the build. +#. Expose the ``sstate-cache`` directory produced by the build. Typically, you expose this directory by making it available through an :wikipedia:`Apache HTTP Server <Apache_HTTP_Server>` or :wikipedia:`Nginx <Nginx>` server. -3. Set the appropriate configuration so that the produced SDK knows how +#. Set the appropriate configuration so that the produced SDK knows how to find the configuration. The variable you need to set is :term:`SSTATE_MIRRORS`::
documentation/sdk-manual/appendix-obtain.rst +14 -14
@@ -28,14 +28,14 @@ and then run the script to hand-install the toolchain. Follow these steps to locate and hand-install the toolchain: -1. *Go to the Installers Directory:* Go to +#. *Go to the Installers Directory:* Go to :yocto_dl:`/releases/yocto/yocto-&DISTRO;/toolchain/` -2. *Open the Folder for Your Build Host:* Open the folder that matches +#. *Open the Folder for Your Build Host:* Open the folder that matches your :term:`Build Host` (i.e. ``i686`` for 32-bit machines or ``x86_64`` for 64-bit machines). -3. *Locate and Download the SDK Installer:* You need to find and +#. *Locate and Download the SDK Installer:* You need to find and download the installer appropriate for your build host, target hardware, and image type.
@@ -72,7 +72,7 @@ Follow these steps to locate and hand-install the toolchain: poky-glibc-x86_64-core-image-sato-core2-64-toolchain-ext-&DISTRO;.sh -4. *Run the Installer:* Be sure you have execution privileges and run +#. *Run the Installer:* Be sure you have execution privileges and run the installer. Following is an example from the ``Downloads`` directory::
@@ -91,13 +91,13 @@ Building an SDK Installer As an alternative to locating and downloading an SDK installer, you can build the SDK installer. Follow these steps: -1. *Set Up the Build Environment:* Be sure you are set up to use BitBake +#. *Set Up the Build Environment:* Be sure you are set up to use BitBake in a shell. See the ":ref:`dev-manual/start:preparing the build host`" section in the Yocto Project Development Tasks Manual for information on how to get a build host ready that is either a native Linux machine or a machine that uses CROPS. -2. *Clone the ``poky`` Repository:* You need to have a local copy of the +#. *Clone the ``poky`` Repository:* You need to have a local copy of the Yocto Project :term:`Source Directory` (i.e. a local ``poky`` repository). See the ":ref:`dev-manual/start:cloning the \`\`poky\`\` repository`" and
@@ -107,7 +107,7 @@ build the SDK installer. Follow these steps: how to clone the ``poky`` repository and check out the appropriate branch for your work. -3. *Initialize the Build Environment:* While in the root directory of +#. *Initialize the Build Environment:* While in the root directory of the Source Directory (i.e. ``poky``), run the :ref:`structure-core-script` environment setup script to define the OpenEmbedded build environment on your
@@ -120,12 +120,12 @@ build the SDK installer. Follow these steps: the script runs, your current working directory is set to the ``build`` directory. -4. *Make Sure You Are Building an Installer for the Correct Machine:* +#. *Make Sure You Are Building an Installer for the Correct Machine:* Check to be sure that your :term:`MACHINE` variable in the ``local.conf`` file in your :term:`Build Directory` matches the architecture for which you are building. -5. *Make Sure Your SDK Machine is Correctly Set:* If you are building a +#. *Make Sure Your SDK Machine is Correctly Set:* If you are building a toolchain designed to run on an architecture that differs from your current development host machine (i.e. the build host), be sure that the :term:`SDKMACHINE` variable in the ``local.conf`` file in your
@@ -145,7 +145,7 @@ build the SDK installer. Follow these steps: different from the architecture of the build machine (``x86_64``). -6. *Build the SDK Installer:* To build the SDK installer for a standard +#. *Build the SDK Installer:* To build the SDK installer for a standard SDK and populate the SDK image, use the following command form. Be sure to replace ``image`` with an image (e.g. "core-image-sato")::
@@ -175,7 +175,7 @@ build the SDK installer. Follow these steps: static development libraries: TOOLCHAIN_TARGET_TASK:append = " libc-staticdev" -7. *Run the Installer:* You can now run the SDK installer from +#. *Run the Installer:* You can now run the SDK installer from ``tmp/deploy/sdk`` in the :term:`Build Directory`. Following is an example:: $ cd poky/build/tmp/deploy/sdk
@@ -203,7 +203,7 @@ separately extract a root filesystem: Follow these steps to extract the root filesystem: -1. *Locate and Download the Tarball for the Pre-Built Root Filesystem +#. *Locate and Download the Tarball for the Pre-Built Root Filesystem Image File:* You need to find and download the root filesystem image file that is appropriate for your target system. These files are kept in machine-specific folders in the
@@ -241,7 +241,7 @@ Follow these steps to extract the root filesystem: core-image-sato-sdk-beaglebone-yocto.tar.bz2 -2. *Initialize the Cross-Development Environment:* You must ``source`` +#. *Initialize the Cross-Development Environment:* You must ``source`` the cross-development environment setup script to establish necessary environment variables.
@@ -253,7 +253,7 @@ Follow these steps to extract the root filesystem: $ source poky_sdk/environment-setup-core2-64-poky-linux -3. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` +#. *Extract the Root Filesystem:* Use the ``runqemu-extract-sdk`` command and provide the root filesystem image. Following is an example command that extracts the root filesystem
documentation/sdk-manual/extensible.rst +29 -29
187 lines not on this page · raw message
documentation/sdk-manual/intro.rst +3 -3
@@ -164,11 +164,11 @@ image. You just need to follow these general steps: -1. *Install the SDK for your target hardware:* For information on how to +#. *Install the SDK for your target hardware:* For information on how to install the SDK, see the ":ref:`sdk-manual/using:installing the sdk`" section. -2. *Download or Build the Target Image:* The Yocto Project supports +#. *Download or Build the Target Image:* The Yocto Project supports several target architectures and has many pre-built kernel images and root filesystem images.
@@ -195,7 +195,7 @@ You just need to follow these general steps: ":ref:`sdk-manual/appendix-obtain:extracting the root filesystem`" section for information on how to do this extraction. -3. *Develop and Test your Application:* At this point, you have the +#. *Develop and Test your Application:* At this point, you have the tools to develop your application. If you need to separately install and use the QEMU emulator, you can go to `QEMU Home Page <https://wiki.qemu.org/Main_Page>`__ to download and learn about
documentation/sdk-manual/working-projects.rst +11 -11
@@ -31,7 +31,7 @@ project: GNOME Developer site. -1. *Create a Working Directory and Populate It:* Create a clean +#. *Create a Working Directory and Populate It:* Create a clean directory for your project and then make that directory your working location::
@@ -74,7 +74,7 @@ project: bin_PROGRAMS = hello hello_SOURCES = hello.c -2. *Source the Cross-Toolchain Environment Setup File:* As described +#. *Source the Cross-Toolchain Environment Setup File:* As described earlier in the manual, installing the cross-toolchain creates a cross-toolchain environment setup script in the directory that the SDK was installed. Before you can use the tools to develop your
@@ -92,7 +92,7 @@ project: $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux -3. *Create the configure Script:* Use the ``autoreconf`` command to +#. *Create the configure Script:* Use the ``autoreconf`` command to generate the ``configure`` script:: $ autoreconf
@@ -108,7 +108,7 @@ project: which ensures missing auxiliary files are copied to the build host. -4. *Cross-Compile the Project:* This command compiles the project using +#. *Cross-Compile the Project:* This command compiles the project using the cross-compiler. The :term:`CONFIGURE_FLAGS` environment variable provides the minimal arguments for GNU
@@ -129,7 +129,7 @@ project: $ ./configure --host=armv5te-poky-linux-gnueabi --with-libtool-sysroot=sysroot_dir -5. *Make and Install the Project:* These two commands generate and +#. *Make and Install the Project:* These two commands generate and install the project into the destination directory:: $ make
@@ -149,7 +149,7 @@ project: $ file ./tmp/usr/local/bin/hello -6. *Execute Your Project:* To execute the project, you would need to run +#. *Execute Your Project:* To execute the project, you would need to run it on your target hardware. If your target hardware happens to be your build host, you could run the project as follows::
@@ -227,7 +227,7 @@ established through the script:: To illustrate variable use, work through this simple "Hello World!" example: -1. *Create a Working Directory and Populate It:* Create a clean +#. *Create a Working Directory and Populate It:* Create a clean directory for your project and then make that directory your working location::
@@ -266,7 +266,7 @@ example: printf("\n"); } -2. *Source the Cross-Toolchain Environment Setup File:* As described +#. *Source the Cross-Toolchain Environment Setup File:* As described earlier in the manual, installing the cross-toolchain creates a cross-toolchain environment setup script in the directory that the SDK was installed. Before you can use the tools to develop your
@@ -284,7 +284,7 @@ example: $ source tmp/deploy/images/qemux86-64/environment-setup-core2-64-poky-linux -3. *Create the Makefile:* For this example, the Makefile contains +#. *Create the Makefile:* For this example, the Makefile contains two lines that can be used to set the :term:`CC` variable. One line is identical to the value that is set when you run the SDK environment setup script, and the other line sets :term:`CC` to "gcc", the default
@@ -302,7 +302,7 @@ example: rm -rf *.o rm target_bin -4. *Make the Project:* Use the ``make`` command to create the binary +#. *Make the Project:* Use the ``make`` command to create the binary output file. Because variables are commented out in the Makefile, the value used for :term:`CC` is the value set when the SDK environment setup file was run::
@@ -387,7 +387,7 @@ example: use the SDK environment variables regardless of the values in the Makefile. -5. *Execute Your Project:* To execute the project (i.e. ``target_bin``), +#. *Execute Your Project:* To execute the project (i.e. ``target_bin``), use the following command:: $ ./target_bin
documentation/toaster-manual/reference.rst +4 -4
@@ -188,17 +188,17 @@ The ``bldcontrol/management/commands/checksettings.py`` file controls workflow configuration. Here is the process to initially populate this database. -1. The default project settings are set from +#. The default project settings are set from ``orm/fixtures/settings.xml``. -2. The default project distro and layers are added from +#. The default project distro and layers are added from ``orm/fixtures/poky.xml`` if poky is installed. If poky is not installed, they are added from ``orm/fixtures/oe-core.xml``. -3. If the ``orm/fixtures/custom.xml`` file exists, then its values are +#. If the ``orm/fixtures/custom.xml`` file exists, then its values are added. -4. The layer index is then scanned and added to the database. +#. The layer index is then scanned and added to the database. Once these steps complete, Toaster is set up and ready to use.
Signature · 1 line
2.37.2