mirrors/poky
1
0
Fork 0
mirror of https://git.yoctoproject.org/poky synced 2026-01-29 21:08:42 +01:00
Code Issues Packages Projects Releases Wiki Activity

manuals: remove tab characters

Browse Source 
As reported by "make sphinx-lint"

Tabs are even removed in Makefile examples,
as Sphinx turns them to spaces anyway in the generated output.

(From yocto-docs rev: 20e9c0c9fad3109567948af6bc40bb0fa2a5552b)

Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Reviewed-by: Quentin Schulz <quentin.schulz@theobroma-systems.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
This commit is contained in:
Michael Opdenacker
2024-03-30 18:56:12 +01:00
committed by Richard Purdie
parent 3ad2f245f0
commit a738448d83
7 changed files with 102 additions and 102 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
documentation/dev-manual/layers.rst
View File

@@ -501,12 +501,12 @@ the "meta" layer at ``meta/recipes-bsp/formfactor``::
INHIBIT_DEFAULT_DEPS = "1" INHIBIT_DEFAULT_DEPS = "1"
do_install() { do_install() {
# Install file only if it has contents # Install file only if it has contents
install -d ${D}${sysconfdir}/formfactor/ install -d ${D}${sysconfdir}/formfactor/
install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/ install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/
if [ -s "${S}/machconfig" ]; then if [ -s "${S}/machconfig" ]; then
install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/ install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/
fi fi
} }
In the main recipe, note the :term:`SRC_URI` In the main recipe, note the :term:`SRC_URI`
@@ -582,10 +582,10 @@ Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named
ALLOW_EMPTY:${PN} = "1" ALLOW_EMPTY:${PN} = "1"
do_install () { do_install () {
if test -s ${WORKDIR}/xorg.conf; then if test -s ${WORKDIR}/xorg.conf; then
install -d ${D}/${sysconfdir}/X11 install -d ${D}/${sysconfdir}/X11
install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/ install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/
fi fi
} }
Here is the append file, which is named ``xserver-xf86-config_%.bbappend`` Here is the append file, which is named ``xserver-xf86-config_%.bbappend``

52
documentation/dev-manual/wic.rst
View File

@@ -139,20 +139,20 @@ individual images through the ``list`` command. You can use the ``list``
command to return the available Wic images as follows:: command to return the available Wic images as follows::
$ wic list images $ wic list images
genericx86 Create an EFI disk image for genericx86* genericx86 Create an EFI disk image for genericx86*
beaglebone-yocto Create SD card image for Beaglebone beaglebone-yocto Create SD card image for Beaglebone
qemuriscv Create qcow2 image for RISC-V QEMU machines qemuriscv Create qcow2 image for RISC-V QEMU machines
mkefidisk Create an EFI disk image mkefidisk Create an EFI disk image
qemuloongarch Create qcow2 image for LoongArch QEMU machines qemuloongarch Create qcow2 image for LoongArch QEMU machines
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image directdisk Create a 'pcbios' direct disk image
efi-bootdisk efi-bootdisk
mkhybridiso Create a hybrid ISO image mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot systemd-bootdisk Create an EFI disk image with systemd-boot
sdimage-bootpart Create SD card image with a boot partition sdimage-bootpart Create SD card image with a boot partition
qemux86-directdisk Create a qemu machine 'pcbios' direct disk image qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
Once you know the list of available Once you know the list of available
Wic images, you can use ``help`` with the command to get help on a Wic images, you can use ``help`` with the command to get help on a
@@ -282,20 +282,20 @@ following two locations::
Use the following command to list the available kickstart files:: Use the following command to list the available kickstart files::
$ wic list images $ wic list images
genericx86 Create an EFI disk image for genericx86* genericx86 Create an EFI disk image for genericx86*
beaglebone-yocto Create SD card image for Beaglebone beaglebone-yocto Create SD card image for Beaglebone
qemuriscv Create qcow2 image for RISC-V QEMU machines qemuriscv Create qcow2 image for RISC-V QEMU machines
mkefidisk Create an EFI disk image mkefidisk Create an EFI disk image
qemuloongarch Create qcow2 image for LoongArch QEMU machines qemuloongarch Create qcow2 image for LoongArch QEMU machines
directdisk-multi-rootfs Create multi rootfs image using rootfs plugin directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
directdisk Create a 'pcbios' direct disk image directdisk Create a 'pcbios' direct disk image
efi-bootdisk efi-bootdisk
mkhybridiso Create a hybrid ISO image mkhybridiso Create a hybrid ISO image
directdisk-gpt Create a 'pcbios' direct disk image directdisk-gpt Create a 'pcbios' direct disk image
systemd-bootdisk Create an EFI disk image with systemd-boot systemd-bootdisk Create an EFI disk image with systemd-boot
sdimage-bootpart Create SD card image with a boot partition sdimage-bootpart Create SD card image with a boot partition
qemux86-directdisk Create a qemu machine 'pcbios' direct disk image qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
When you use an existing file, you When you use an existing file, you
do not have to use the ``.wks`` extension. Here is an example in Raw do not have to use the ``.wks`` extension. Here is an example in Raw

4
documentation/kernel-dev/advanced.rst
View File

@@ -303,8 +303,8 @@ The following listings show the ``build.scc`` file and part of the
. .
. .
. .
char *dump_write = NULL, *files_source = NULL; char *dump_write = NULL, *files_source = NULL;
int opt; int opt;
-- --
2.10.1 2.10.1

4
documentation/kernel-dev/common.rst
View File

@@ -1668,10 +1668,10 @@ looks much like the one provided with the ``hello-mod`` template::
SRC := $(shell pwd) SRC := $(shell pwd)
all: all:
$(MAKE) -C $(KERNEL_SRC) M=$(SRC) $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
modules_install: modules_install:
$(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
... ...
The important point to note here is the :term:`KERNEL_SRC` variable. The The important point to note here is the :term:`KERNEL_SRC` variable. The

112
documentation/profile-manual/usage.rst
View File

@@ -1058,13 +1058,13 @@ section::
name: do_fork name: do_fork
ID: 944 ID: 944
format: format:
field:unsigned short common_type; offset:0; size:2; signed:0; field:unsigned short common_type; offset:0; size:2; signed:0;
field:unsigned char common_flags; offset:2; size:1; signed:0; field:unsigned char common_flags; offset:2; size:1; signed:0;
field:unsigned char common_preempt_count; offset:3; size:1; signed:0; field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
field:int common_pid; offset:4; size:4; signed:1; field:int common_pid; offset:4; size:4; signed:1;
field:int common_padding; offset:8; size:4; signed:1; field:int common_padding; offset:8; size:4; signed:1;
field:unsigned long __probe_ip; offset:12; size:4; signed:0; field:unsigned long __probe_ip; offset:12; size:4; signed:0;
print fmt: "(%lx)", REC->__probe_ip print fmt: "(%lx)", REC->__probe_ip
@@ -1550,17 +1550,17 @@ like ftrace to display the event as text. The format of the
name: kmalloc name: kmalloc
ID: 313 ID: 313
format: format:
field:unsigned short common_type; offset:0; size:2; signed:0; field:unsigned short common_type; offset:0; size:2; signed:0;
field:unsigned char common_flags; offset:2; size:1; signed:0; field:unsigned char common_flags; offset:2; size:1; signed:0;
field:unsigned char common_preempt_count; offset:3; size:1; signed:0; field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
field:int common_pid; offset:4; size:4; signed:1; field:int common_pid; offset:4; size:4; signed:1;
field:int common_padding; offset:8; size:4; signed:1; field:int common_padding; offset:8; size:4; signed:1;
field:unsigned long call_site; offset:16; size:8; signed:0; field:unsigned long call_site; offset:16; size:8; signed:0;
field:const void * ptr; offset:24; size:8; signed:0; field:const void * ptr; offset:24; size:8; signed:0;
field:size_t bytes_req; offset:32; size:8; signed:0; field:size_t bytes_req; offset:32; size:8; signed:0;
field:size_t bytes_alloc; offset:40; size:8; signed:0; field:size_t bytes_alloc; offset:40; size:8; signed:0;
field:gfp_t gfp_flags; offset:48; size:4; signed:0; field:gfp_t gfp_flags; offset:48; size:4; signed:0;
print fmt: "call_site=%lx ptr=%p bytes_req=%zu bytes_alloc=%zu gfp_flags=%s", REC->call_site, REC->ptr, REC->bytes_req, REC->bytes_alloc, print fmt: "call_site=%lx ptr=%p bytes_req=%zu bytes_alloc=%zu gfp_flags=%s", REC->call_site, REC->ptr, REC->bytes_req, REC->bytes_alloc,
(REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | (( (REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | ((
@@ -2355,29 +2355,29 @@ first part of the filenames::
8,32 1 0 58.516990819 0 m N cfq3551 put_queue 8,32 1 0 58.516990819 0 m N cfq3551 put_queue
CPU0 (sdc): CPU0 (sdc):
Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB
Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB
Read Merges: 0, 0KiB Write Merges: 13, 160KiB Read Merges: 0, 0KiB Write Merges: 13, 160KiB
Read depth: 0 Write depth: 2 Read depth: 0 Write depth: 2
IO unplugs: 23 Timer unplugs: 0 IO unplugs: 23 Timer unplugs: 0
CPU1 (sdc): CPU1 (sdc):
Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB
Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB
Read Merges: 0, 0KiB Write Merges: 40, 276KiB Read Merges: 0, 0KiB Write Merges: 40, 276KiB
Read depth: 0 Write depth: 2 Read depth: 0 Write depth: 2
IO unplugs: 30 Timer unplugs: 1 IO unplugs: 30 Timer unplugs: 1
Total (sdc): Total (sdc):
Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB
Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB
Read Merges: 0, 0KiB Write Merges: 53, 436KiB Read Merges: 0, 0KiB Write Merges: 53, 436KiB
IO unplugs: 53 Timer unplugs: 1 IO unplugs: 53 Timer unplugs: 1
Throughput (R/W): 0KiB/s / 719KiB/s Throughput (R/W): 0KiB/s / 719KiB/s
Events (sdc): 6,592 entries Events (sdc): 6,592 entries
@@ -2500,29 +2500,29 @@ And run blkparse on the host system using the device name::
8,32 1 0 177.266696560 0 m N cfq1267 put_queue 8,32 1 0 177.266696560 0 m N cfq1267 put_queue
CPU0 (sdc): CPU0 (sdc):
Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB
Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB
Read Merges: 0, 0KiB Write Merges: 9, 344KiB Read Merges: 0, 0KiB Write Merges: 9, 344KiB
Read depth: 2 Write depth: 2 Read depth: 2 Write depth: 2
IO unplugs: 20 Timer unplugs: 1 IO unplugs: 20 Timer unplugs: 1
CPU1 (sdc): CPU1 (sdc):
Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB
Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB
Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB
Read depth: 2 Write depth: 2 Read depth: 2 Write depth: 2
IO unplugs: 52 Timer unplugs: 0 IO unplugs: 52 Timer unplugs: 0
Total (sdc): Total (sdc):
Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB
Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB
Reads Requeued: 0 Writes Requeued: 0 Reads Requeued: 0 Writes Requeued: 0
Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB
Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB
IO unplugs: 72 Timer unplugs: 1 IO unplugs: 72 Timer unplugs: 1
Throughput (R/W): 15KiB/s / 238KiB/s Throughput (R/W): 15KiB/s / 238KiB/s
Events (sdc): 9,301 entries Events (sdc): 9,301 entries

10
documentation/ref-manual/terms.rst
View File

@@ -228,23 +228,23 @@ universal, the list includes them just in case:
As far as bootloaders are concerned, :term:`Initramfs` and "initrd" As far as bootloaders are concerned, :term:`Initramfs` and "initrd"
images are still copied to RAM in the same way. That's why most images are still copied to RAM in the same way. That's why most
most bootloaders refer to :term:`Initramfs` images as "initrd" most bootloaders refer to :term:`Initramfs` images as "initrd"
or "init RAM disk". or "init RAM disk".
This kind of mechanism is typically used for two reasons: This kind of mechanism is typically used for two reasons:
- For booting the same kernel binary on multiple systems requiring - For booting the same kernel binary on multiple systems requiring
different device drivers. The :term:`Initramfs` image is then customized different device drivers. The :term:`Initramfs` image is then customized
for each type of system, to include the specific kernel modules for each type of system, to include the specific kernel modules
necessary to access the final root filesystem. This technique necessary to access the final root filesystem. This technique
is used on all GNU / Linux distributions for desktops and servers. is used on all GNU / Linux distributions for desktops and servers.
- For booting faster. As the root filesystem is extracted into RAM, - For booting faster. As the root filesystem is extracted into RAM,
accessing the first user-space applications is very fast, compared accessing the first user-space applications is very fast, compared
to having to initialize a block device, to access multiple blocks to having to initialize a block device, to access multiple blocks
from it, and to go through a filesystem having its own overhead. from it, and to go through a filesystem having its own overhead.
For example, this allows to display a splashscreen very early, For example, this allows to display a splashscreen very early,
and to later take care of mounting the final root filesystem and and to later take care of mounting the final root filesystem and
loading less time-critical kernel drivers. loading less time-critical kernel drivers.
This cpio archive can either be loaded to RAM by the bootloader, This cpio archive can either be loaded to RAM by the bootloader,

6
documentation/sdk-manual/working-projects.rst
View File

@@ -295,12 +295,12 @@ example:
all: main.o module.o all: main.o module.o
${CC} main.o module.o -o target_bin ${CC} main.o module.o -o target_bin
main.o: main.c module.h main.o: main.c module.h
${CC} -I . -c main.c ${CC} -I . -c main.c
module.o: module.c module.h module.o: module.c module.h
${CC} -I . -c module.c ${CC} -I . -c module.c
clean: clean:
rm -rf *.o rm -rf *.o
rm target_bin rm target_bin
#. *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 output file. Because variables are commented out in the Makefile, the