mirror of
git://git.yoctoproject.org/poky.git
synced 2025-07-19 12:59:02 +02:00
manuals: Fix typos and spacing
Fix double words, punctuation spacing issues, spacing issues, "its" instead of "it's", and other trivial issues. (From yocto-docs rev: 56eb1f340a7af112e62c1d8ad02d4bec0ad88313) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
parent
5480a85f01
commit
44d0532c89
|
@ -109,7 +109,7 @@ obvious reasons, we will only support building the Yocto Project
|
|||
documentation with Python3.
|
||||
|
||||
Sphinx might be available in your Linux distro packages repositories,
|
||||
however it is not recommend to use distro packages, as they might be
|
||||
however it is not recommended to use distro packages, as they might be
|
||||
old versions, especially if you are using an LTS version of your
|
||||
distro. The recommended method to install Sphinx and all required
|
||||
dependencies is to use the Python Package Index (pip).
|
||||
|
|
|
@ -250,7 +250,7 @@ standardization of software support for hardware.
|
|||
The proposed form described in this section does have elements that are
|
||||
specific to the OpenEmbedded build system. It is intended that
|
||||
developers can use this structure with other build systems besides the
|
||||
OpenEmbedded build system. It is also intended that it will be be simple
|
||||
OpenEmbedded build system. It is also intended that it will be simple
|
||||
to extract information and convert it to other formats if required. The
|
||||
OpenEmbedded build system, through its standard :ref:`layers mechanism
|
||||
<overview-manual/yp-intro:the yocto project layer model>`, can
|
||||
|
@ -1036,7 +1036,7 @@ the following:
|
|||
to reside in a machine-specific directory.
|
||||
|
||||
Following is a specific example to help you better understand the
|
||||
process. This example customizes customizes a recipe by adding a
|
||||
process. This example customizes a recipe by adding a
|
||||
BSP-specific configuration file named ``interfaces`` to the
|
||||
``init-ifupdown_1.0.bb`` recipe for machine "xyz" where the BSP layer
|
||||
also supports several other machines:
|
||||
|
|
|
@ -2065,7 +2065,7 @@ A subset of the files installed by the
|
|||
:ref:`ref-tasks-install` task are
|
||||
used by the
|
||||
:ref:`ref-tasks-populate_sysroot`
|
||||
task as defined by the the
|
||||
task as defined by the
|
||||
:term:`SYSROOT_DIRS` variable to
|
||||
automatically populate the sysroot. It is possible to modify the list of
|
||||
directories that populate the sysroot. The following example shows how
|
||||
|
@ -4591,7 +4591,7 @@ directory:
|
|||
section.
|
||||
|
||||
3. Once you have the correct source revisions, you can modify
|
||||
those recipes to to set ``SRCREV`` to specific versions of the
|
||||
those recipes to set ``SRCREV`` to specific versions of the
|
||||
software.
|
||||
|
||||
Speeding Up a Build
|
||||
|
@ -6599,7 +6599,7 @@ Quality <#maintaining-build-output-quality>`__" section.
|
|||
|
||||
The OpenEmbedded build system does not maintain ``PR`` information as
|
||||
part of the shared state (sstate) packages. If you maintain an sstate
|
||||
feed, its expected that either all your building systems that
|
||||
feed, it's expected that either all your building systems that
|
||||
contribute to the sstate feed use a shared PR Service, or you do not
|
||||
run a PR Service on any of your building systems. Having some systems
|
||||
use a PR Service while others do not leads to obvious problems.
|
||||
|
@ -7070,7 +7070,7 @@ runtime package management of RPM packages. In order to use DNF for
|
|||
runtime package management, you must perform an initial setup on the
|
||||
target machine for cases where the ``PACKAGE_FEED_*`` variables were not
|
||||
set as part of the image that is running on the target. This means if
|
||||
you built your image and did not not use these variables as part of the
|
||||
you built your image and did not use these variables as part of the
|
||||
build and your image is now running on the target, you need to perform
|
||||
the steps in this section if you want to use runtime package management.
|
||||
|
||||
|
|
|
@ -1914,7 +1914,7 @@ differences:
|
|||
$ git show origin/standard/base..origin/standard/emenlow
|
||||
|
||||
Use this command to create individual patches for each change. Here is
|
||||
an example that that creates patch files for each commit and places them
|
||||
an example that creates patch files for each commit and places them
|
||||
in your ``Documents`` directory:
|
||||
::
|
||||
|
||||
|
|
|
@ -64,7 +64,7 @@ the "yocto-4.12" branch of the ``yocto-kernel-cache`` repository:
|
|||
kernel versions (e.g. "yocto-4.12", "yocto-4.10", "yocto-4.9", and so forth).
|
||||
|
||||
Once you have checked out and switched to appropriate branches, you can
|
||||
see a snapshot of all the kernel source files used to used to build that
|
||||
see a snapshot of all the kernel source files used to build that
|
||||
particular Yocto Linux kernel for a particular board.
|
||||
|
||||
To see the features and configurations for a particular Yocto Linux
|
||||
|
|
|
@ -272,7 +272,7 @@ of the ``poky`` repository, you will see several layers: ``meta``,
|
|||
``meta-yocto-bsp``. Each of these repositories represents a distinct
|
||||
layer.
|
||||
|
||||
For procedures on how to create layers, see the
|
||||
For procedures on how to create layers, see the
|
||||
":ref:`dev-manual/common-tasks:understanding and creating layers`"
|
||||
section in the Yocto Project Development Tasks Manual.
|
||||
|
||||
|
@ -283,7 +283,7 @@ The Yocto Project employs a collection of components and tools used by
|
|||
the project itself, by project developers, and by those using the Yocto
|
||||
Project. These components and tools are open source projects and
|
||||
metadata that are separate from the reference distribution
|
||||
(:term:`Poky`) and the
|
||||
(:term:`Poky`) and the
|
||||
:term:`OpenEmbedded Build System`. Most of the
|
||||
components and tools are downloaded separately.
|
||||
|
||||
|
@ -325,7 +325,7 @@ applications using the Yocto Project:
|
|||
|
||||
You can read about the ``devtool`` workflow in the Yocto Project
|
||||
Application Development and Extensible Software Development Kit
|
||||
(eSDK) Manual in the
|
||||
(eSDK) Manual in the
|
||||
":ref:`sdk-manual/extensible:using \`\`devtool\`\` in your sdk workflow`"
|
||||
section.
|
||||
|
||||
|
@ -571,7 +571,7 @@ Linux.
|
|||
Development Methods
|
||||
===================
|
||||
|
||||
The Yocto Project development environment usually involves a
|
||||
The Yocto Project development environment usually involves a
|
||||
:term:`Build Host` and target
|
||||
hardware. You use the Build Host to build images and develop
|
||||
applications, while you use the target hardware to test deployed
|
||||
|
@ -597,7 +597,7 @@ Project.
|
|||
supported Linux distribution.
|
||||
|
||||
For information on how to set up a Build Host on a system running
|
||||
Linux as its native operating system, see the
|
||||
Linux as its native operating system, see the
|
||||
":ref:`dev-manual/start:setting up a native linux host`"
|
||||
section in the Yocto Project Development Tasks Manual.
|
||||
|
||||
|
@ -646,7 +646,7 @@ Project.
|
|||
builds is collected and stored in a database. You can use Toaster to
|
||||
configure and start builds on multiple remote build servers.
|
||||
|
||||
For information about and how to use Toaster, see the
|
||||
For information about and how to use Toaster, see the
|
||||
:doc:`/toaster-manual/index`.
|
||||
|
||||
Reference Embedded Distribution (Poky)
|
||||
|
@ -820,10 +820,10 @@ helpful for getting started:
|
|||
them. You can search the Layer Index for layers used within Yocto
|
||||
Project.
|
||||
|
||||
For more detailed information on layers, see the
|
||||
For more detailed information on layers, see the
|
||||
":ref:`dev-manual/common-tasks:understanding and creating layers`"
|
||||
section in the Yocto Project Development Tasks Manual. For a
|
||||
discussion specifically on BSP Layers, see the
|
||||
discussion specifically on BSP Layers, see the
|
||||
":ref:`bsp-guide/bsp:bsp layers`" section in the Yocto
|
||||
Project Board Support Packages (BSP) Developer's Guide.
|
||||
|
||||
|
|
|
@ -256,7 +256,7 @@ important for now), which takes the buffers the kernel passes to it and
|
|||
writes it to a disk file to save it.
|
||||
|
||||
The part of this process that we're looking at in the above call stacks
|
||||
is the part where the kernel passes the data it's read from the socket
|
||||
is the part where the kernel passes the data it has read from the socket
|
||||
down to wget i.e. a copy-to-user.
|
||||
|
||||
Notice also that here there's also a case where the hex value is
|
||||
|
@ -1580,7 +1580,7 @@ events in the output buffer: ::
|
|||
root@sugarbay:/sys/kernel/debug/tracing# echo nop > current_tracer
|
||||
root@sugarbay:/sys/kernel/debug/tracing# echo 1 > tracing_on
|
||||
|
||||
Now, if we look at the the 'trace' file, we see nothing
|
||||
Now, if we look at the 'trace' file, we see nothing
|
||||
but the kmalloc events we just turned on: ::
|
||||
|
||||
root@sugarbay:/sys/kernel/debug/tracing# cat trace | less
|
||||
|
|
|
@ -1,10 +1,10 @@
|
|||
Handbook Todo List:
|
||||
|
||||
* Document adding a new IMAGE_FEATURE to the customising images section
|
||||
* Document adding a new IMAGE_FEATURE to the customising images section
|
||||
* Add instructions about using zaurus/openmoko emulation
|
||||
* Add component overview/block diagrams
|
||||
* Software Deevelopment intro should mention its software development for
|
||||
intended target and could be a different arch etc and thus special case.
|
||||
* Software Development intro should mention its software development for
|
||||
intended target and could be a different arch etc and thus special case.
|
||||
* Expand insane.bbclass documentation to cover tests
|
||||
* Document remaining classes (see list in ref-classes)
|
||||
* Document formfactor
|
||||
|
|
|
@ -1426,7 +1426,7 @@ Only a single U-boot boot script can be added to the FIT image created by
|
|||
The boot script is specified in the ITS file as a text file containing
|
||||
U-boot commands. When using a boot script the user should configure the
|
||||
U-boot ``do_install`` task to copy the script to sysroot.
|
||||
So the script can be included in the the FIT image by the ``kernel-fitimage``
|
||||
So the script can be included in the FIT image by the ``kernel-fitimage``
|
||||
class. At run-time, U-boot CONFIG_BOOTCOMMAND define can be configured to
|
||||
load the boot script from the FIT image and executes it.
|
||||
|
||||
|
|
|
@ -449,7 +449,7 @@ variable ``bindir``. The makefile's hardcoded default value of
|
|||
"/usr/bin" worked most of the time, but not for the recipe's ``-native``
|
||||
variant. For another example, permissions errors might be caused by a
|
||||
Makefile that ignores ``DESTDIR`` or uses a different name for that
|
||||
environment variable. Check the the build system to see if these kinds
|
||||
environment variable. Check the build system to see if these kinds
|
||||
of issues exist.
|
||||
|
||||
**Q:** I'm adding a binary in a recipe but it's different in the image, what is
|
||||
|
|
|
@ -12,7 +12,7 @@ Changes to Setting QEMU ``PACKAGECONFIG`` Options in ``local.conf``
|
|||
The QEMU recipe now uses a number of
|
||||
:term:`PACKAGECONFIG` options to enable various
|
||||
optional features. The method used to set defaults for these options
|
||||
means that existing ``local.conf`` files will need to be be modified to
|
||||
means that existing ``local.conf`` files will need to be modified to
|
||||
append to ``PACKAGECONFIG`` for ``qemu-native`` and ``nativesdk-qemu``
|
||||
instead of setting it. In other words, to enable graphical output for
|
||||
QEMU, you should now have these lines in ``local.conf``:
|
||||
|
|
|
@ -135,7 +135,7 @@ consists of the following pieces:
|
|||
|
||||
- :ref:`ptest <dev-manual/common-tasks:testing packages with ptest>`:
|
||||
Runs tests against packages produced during the build for a given
|
||||
piece of software. The test allows the packages to be be run within a
|
||||
piece of software. The test allows the packages to be run within a
|
||||
target image.
|
||||
|
||||
- ``oe-selftest``: Tests combination BitBake invocations. These tests
|
||||
|
|
|
@ -294,7 +294,7 @@ installer and automatically installs the tools for you:
|
|||
|
||||
During execution, the buildtools tarball will be downloaded, the
|
||||
checksum of the download will be verified, the installer will be run
|
||||
for you, and some basic checks will be run to to make sure the
|
||||
for you, and some basic checks will be run to make sure the
|
||||
installation is functional.
|
||||
|
||||
To avoid the need of ``sudo`` privileges, the ``install-buildtools``
|
||||
|
|
|
@ -2991,7 +2991,7 @@ system and gives an overview of their function and contents.
|
|||
|
||||
:term:`IMAGE_CMD`
|
||||
Specifies the command to create the image file for a specific image
|
||||
type, which corresponds to the value set set in
|
||||
type, which corresponds to the value set in
|
||||
:term:`IMAGE_FSTYPES`, (e.g. ``ext3``,
|
||||
``btrfs``, and so forth). When setting this variable, you should use
|
||||
an override for the associated type. Here is an example:
|
||||
|
@ -3458,7 +3458,7 @@ system and gives an overview of their function and contents.
|
|||
|
||||
This will result in ``INCOMPATIBLE_LICENSE`` containing the names of
|
||||
all licenses from :term:`AVAILABLE_LICENSES` except the ones specified
|
||||
in ``COMPATIBLE_LICENSES`` , thus only allowing the latter licenses to
|
||||
in ``COMPATIBLE_LICENSES``, thus only allowing the latter licenses to
|
||||
be used.
|
||||
|
||||
:term:`INHERIT`
|
||||
|
|
|
@ -139,7 +139,7 @@ Changing the Extensible SDK Installer Title
|
|||
|
||||
You can change the displayed title for the SDK installer by setting the
|
||||
:term:`SDK_TITLE` variable and then
|
||||
rebuilding the the SDK installer. For information on how to build an SDK
|
||||
rebuilding the SDK installer. For information on how to build an SDK
|
||||
installer, see the "`Building an SDK
|
||||
Installer <#sdk-building-an-sdk-installer>`__" section.
|
||||
|
||||
|
|
|
@ -111,7 +111,7 @@ roughly consist of:
|
|||
:ref:`test-manual/understand-autobuilder:Autobuilder Clone Cache`.
|
||||
|
||||
This step has two possible modes of operation. If the build is part
|
||||
of a parent build, its possible that all the repositories needed may
|
||||
of a parent build, it's possible that all the repositories needed may
|
||||
already be available, ready in a pre-prepared directory. An "a-quick"
|
||||
or "a-full" build would prepare this before starting the other
|
||||
sub-target builds. This is done for two reasons:
|
||||
|
@ -130,7 +130,7 @@ roughly consist of:
|
|||
|
||||
#. *Call scripts/run-config*
|
||||
|
||||
This is another call into the Helper scripts where its expected that
|
||||
This is another call into the Helper scripts where it's expected that
|
||||
the main functionality of this target will be executed.
|
||||
|
||||
Autobuilder Technology
|
||||
|
|
|
@ -208,7 +208,7 @@ Customizing Pre-Set Data
|
|||
------------------------
|
||||
|
||||
The pre-set data for Toaster is easily customizable. You can create the
|
||||
``orm/fixtures/custom.xml`` file to customize the values that go into to
|
||||
``orm/fixtures/custom.xml`` file to customize the values that go into
|
||||
the database. Customization is additive, and can either extend or
|
||||
completely replace the existing values.
|
||||
|
||||
|
|
Loading…
Reference in New Issue
Block a user