diff options
| author | Robert P. J. Day <rpjday@crashcourse.ca> | 2021-09-01 06:12:47 -0400 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-09-04 08:46:35 +0100 |
| commit | 4a979c6f1ca15107d0cd86426c06395d60fdc228 (patch) | |
| tree | 449f6cdf072dfa159d5036b14c08abfdce2429a5 /documentation/dev-manual | |
| parent | 055b36a0058f716703ed6a4232312893d88bfc51 (diff) | |
| download | poky-4a979c6f1ca15107d0cd86426c06395d60fdc228.tar.gz | |
dev-manual: small number of minor aesthetic tweaks
Just a collection of:
- grammar tweaks
- space fixes
- font changes
(From yocto-docs rev: c49984f89cd2295c54f01730649aaca83eaf515e)
Signed-off-by: Robert P. J. Day <rpjday@crashcourse.ca>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual')
| -rw-r--r-- | documentation/dev-manual/common-tasks.rst | 28 |
1 files changed, 15 insertions, 13 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 25e6b085e5..7c13eb9600 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst | |||
| @@ -25,7 +25,7 @@ Creating Your Own Layer | |||
| 25 | ----------------------- | 25 | ----------------------- |
| 26 | 26 | ||
| 27 | It is very easy to create your own layers to use with the OpenEmbedded | 27 | It is very easy to create your own layers to use with the OpenEmbedded |
| 28 | build system. The Yocto Project ships with tools that speed up creating | 28 | build system, as the Yocto Project ships with tools that speed up creating |
| 29 | layers. This section describes the steps you perform by hand to create | 29 | layers. This section describes the steps you perform by hand to create |
| 30 | layers so that you can better understand them. For information about the | 30 | layers so that you can better understand them. For information about the |
| 31 | layer-creation tools, see the | 31 | layer-creation tools, see the |
| @@ -843,8 +843,8 @@ the :term:`IMAGE_INSTALL` variable with the ``:append`` operator:: | |||
| 843 | 843 | ||
| 844 | IMAGE_INSTALL:append = " strace" | 844 | IMAGE_INSTALL:append = " strace" |
| 845 | 845 | ||
| 846 | Use of the syntax is important - | 846 | Use of the syntax is important; specifically, the leading space |
| 847 | specifically, the space between the quote and the package name, which is | 847 | after the opening quote and before the package name, which is |
| 848 | ``strace`` in this example. This space is required since the ``:append`` | 848 | ``strace`` in this example. This space is required since the ``:append`` |
| 849 | operator does not add the space. | 849 | operator does not add the space. |
| 850 | 850 | ||
| @@ -3517,9 +3517,9 @@ either by using Ctrl+d or closing the terminal window. | |||
| 3517 | Building | 3517 | Building |
| 3518 | ======== | 3518 | ======== |
| 3519 | 3519 | ||
| 3520 | This section describes various build procedures. For example, the steps | 3520 | This section describes various build procedures, such as the steps |
| 3521 | needed for a simple build, a target that uses multiple configurations, | 3521 | needed for a simple build, building a target for multiple configurations, |
| 3522 | building an image for more than one machine, and so forth. | 3522 | generating an image for more than one machine, and so forth. |
| 3523 | 3523 | ||
| 3524 | Building a Simple Image | 3524 | Building a Simple Image |
| 3525 | ----------------------- | 3525 | ----------------------- |
| @@ -3575,8 +3575,10 @@ The following figure and list overviews the build process: | |||
| 3575 | .. note:: | 3575 | .. note:: |
| 3576 | 3576 | ||
| 3577 | A common practice is to use a different Build Directory for | 3577 | A common practice is to use a different Build Directory for |
| 3578 | different targets. For example, ``~/build/x86`` for a ``qemux86`` | 3578 | different targets; for example, ``~/build/x86`` for a ``qemux86`` |
| 3579 | target, and ``~/build/arm`` for a ``qemuarm`` target. | 3579 | target, and ``~/build/arm`` for a ``qemuarm`` target. In any |
| 3580 | event, it's typically cleaner to locate the build directory | ||
| 3581 | somewhere outside of your source directory. | ||
| 3580 | 3582 | ||
| 3581 | 3. *Make Sure Your* ``local.conf`` *File is Correct*: Ensure the | 3583 | 3. *Make Sure Your* ``local.conf`` *File is Correct*: Ensure the |
| 3582 | ``conf/local.conf`` configuration file, which is found in the Build | 3584 | ``conf/local.conf`` configuration file, which is found in the Build |
| @@ -3599,7 +3601,7 @@ The following figure and list overviews the build process: | |||
| 3599 | The target is the name of the recipe you want to build. Common | 3601 | The target is the name of the recipe you want to build. Common |
| 3600 | targets are the images in ``meta/recipes-core/images``, | 3602 | targets are the images in ``meta/recipes-core/images``, |
| 3601 | ``meta/recipes-sato/images``, and so forth all found in the | 3603 | ``meta/recipes-sato/images``, and so forth all found in the |
| 3602 | :term:`Source Directory`. Or, the target | 3604 | :term:`Source Directory`. Alternatively, the target |
| 3603 | can be the name of a recipe for a specific piece of software such as | 3605 | can be the name of a recipe for a specific piece of software such as |
| 3604 | BusyBox. For more details about the images the OpenEmbedded build | 3606 | BusyBox. For more details about the images the OpenEmbedded build |
| 3605 | system supports, see the | 3607 | system supports, see the |
| @@ -3810,7 +3812,7 @@ Follow these steps to create an initramfs image: | |||
| 3810 | 3812 | ||
| 3811 | .. note:: | 3813 | .. note:: |
| 3812 | 3814 | ||
| 3813 | It is recommended that you do bundle the initramfs image with the | 3815 | It is recommended that you bundle the initramfs image with the |
| 3814 | kernel image to avoid circular dependencies between the kernel | 3816 | kernel image to avoid circular dependencies between the kernel |
| 3815 | recipe and the initramfs recipe should the initramfs image include | 3817 | recipe and the initramfs recipe should the initramfs image include |
| 3816 | kernel modules. | 3818 | kernel modules. |
| @@ -4430,7 +4432,7 @@ directory: | |||
| 4430 | SRCREV = "${AUTOREV}" | 4432 | SRCREV = "${AUTOREV}" |
| 4431 | 4433 | ||
| 4432 | When a recipe sets :term:`SRCREV` to | 4434 | When a recipe sets :term:`SRCREV` to |
| 4433 | ``${AUTOREV}``, the build system accesses the network in an | 4435 | ``${``\ :term:`AUTOREV`\ ``}``, the build system accesses the network in an |
| 4434 | attempt to determine the latest version of software from the SCM. | 4436 | attempt to determine the latest version of software from the SCM. |
| 4435 | Typically, recipes that use :term:`AUTOREV` are custom or modified | 4437 | Typically, recipes that use :term:`AUTOREV` are custom or modified |
| 4436 | recipes. Recipes that reside in public repositories usually do not | 4438 | recipes. Recipes that reside in public repositories usually do not |
| @@ -7571,7 +7573,7 @@ Selecting a Device Manager | |||
| 7571 | The Yocto Project provides multiple ways to manage the device manager | 7573 | The Yocto Project provides multiple ways to manage the device manager |
| 7572 | (``/dev``): | 7574 | (``/dev``): |
| 7573 | 7575 | ||
| 7574 | - Persistent and Pre-Populated\ ``/dev``: For this case, the ``/dev`` | 7576 | - Persistent and Pre-Populated ``/dev``: For this case, the ``/dev`` |
| 7575 | directory is persistent and the required device nodes are created | 7577 | directory is persistent and the required device nodes are created |
| 7576 | during the build. | 7578 | during the build. |
| 7577 | 7579 | ||
| @@ -7581,7 +7583,7 @@ The Yocto Project provides multiple ways to manage the device manager | |||
| 7581 | configuration of device nodes is done in user space by a device | 7583 | configuration of device nodes is done in user space by a device |
| 7582 | manager like ``udev`` or ``busybox-mdev``. | 7584 | manager like ``udev`` or ``busybox-mdev``. |
| 7583 | 7585 | ||
| 7584 | Using Persistent and Pre-Populated\ ``/dev`` | 7586 | Using Persistent and Pre-Populated ``/dev`` |
| 7585 | -------------------------------------------- | 7587 | -------------------------------------------- |
| 7586 | 7588 | ||
| 7587 | To use the static method for device population, you need to set the | 7589 | To use the static method for device population, you need to set the |
