summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2024-03-30 18:56:12 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2024-04-12 17:29:34 +0100
commita738448d83e28e97501ac30076f980efeeab4c83 (patch)
tree2a3c2b59913923d0734b4b72cbb6155c920f6236 /documentation
parent3ad2f245f0780bab65f01bca8b813bae9b06ca76 (diff)
downloadpoky-a738448d83e28e97501ac30076f980efeeab4c83.tar.gz
manuals: remove tab characters
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>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/layers.rst16
-rw-r--r--documentation/dev-manual/wic.rst52
-rw-r--r--documentation/kernel-dev/advanced.rst4
-rw-r--r--documentation/kernel-dev/common.rst4
-rw-r--r--documentation/profile-manual/usage.rst114
-rw-r--r--documentation/ref-manual/terms.rst10
-rw-r--r--documentation/sdk-manual/working-projects.rst6
7 files changed, 103 insertions, 103 deletions
diff --git a/documentation/dev-manual/layers.rst b/documentation/dev-manual/layers.rst
index 9e764c03ba..91889bd0ae 100644
--- a/documentation/dev-manual/layers.rst
+++ b/documentation/dev-manual/layers.rst
@@ -501,12 +501,12 @@ the "meta" layer at ``meta/recipes-bsp/formfactor``::
501 INHIBIT_DEFAULT_DEPS = "1" 501 INHIBIT_DEFAULT_DEPS = "1"
502 502
503 do_install() { 503 do_install() {
504 # Install file only if it has contents 504 # Install file only if it has contents
505 install -d ${D}${sysconfdir}/formfactor/ 505 install -d ${D}${sysconfdir}/formfactor/
506 install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/ 506 install -m 0644 ${S}/config ${D}${sysconfdir}/formfactor/
507 if [ -s "${S}/machconfig" ]; then 507 if [ -s "${S}/machconfig" ]; then
508 install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/ 508 install -m 0644 ${S}/machconfig ${D}${sysconfdir}/formfactor/
509 fi 509 fi
510 } 510 }
511 511
512In the main recipe, note the :term:`SRC_URI` 512In the main recipe, note the :term:`SRC_URI`
@@ -582,10 +582,10 @@ Directory`. Here is the main ``xserver-xf86-config`` recipe, which is named
582 ALLOW_EMPTY:${PN} = "1" 582 ALLOW_EMPTY:${PN} = "1"
583 583
584 do_install () { 584 do_install () {
585 if test -s ${WORKDIR}/xorg.conf; then 585 if test -s ${WORKDIR}/xorg.conf; then
586 install -d ${D}/${sysconfdir}/X11 586 install -d ${D}/${sysconfdir}/X11
587 install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/ 587 install -m 0644 ${WORKDIR}/xorg.conf ${D}/${sysconfdir}/X11/
588 fi 588 fi
589 } 589 }
590 590
591Here is the append file, which is named ``xserver-xf86-config_%.bbappend`` 591Here is the append file, which is named ``xserver-xf86-config_%.bbappend``
diff --git a/documentation/dev-manual/wic.rst b/documentation/dev-manual/wic.rst
index aeecd0dd3e..a3880f3a1c 100644
--- a/documentation/dev-manual/wic.rst
+++ b/documentation/dev-manual/wic.rst
@@ -139,20 +139,20 @@ individual images through the ``list`` command. You can use the ``list``
139command to return the available Wic images as follows:: 139command to return the available Wic images as follows::
140 140
141 $ wic list images 141 $ wic list images
142 genericx86 Create an EFI disk image for genericx86* 142 genericx86 Create an EFI disk image for genericx86*
143 beaglebone-yocto Create SD card image for Beaglebone 143 beaglebone-yocto Create SD card image for Beaglebone
144 qemuriscv Create qcow2 image for RISC-V QEMU machines 144 qemuriscv Create qcow2 image for RISC-V QEMU machines
145 mkefidisk Create an EFI disk image 145 mkefidisk Create an EFI disk image
146 qemuloongarch Create qcow2 image for LoongArch QEMU machines 146 qemuloongarch Create qcow2 image for LoongArch QEMU machines
147 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin 147 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
148 directdisk Create a 'pcbios' direct disk image 148 directdisk Create a 'pcbios' direct disk image
149 efi-bootdisk 149 efi-bootdisk
150 mkhybridiso Create a hybrid ISO image 150 mkhybridiso Create a hybrid ISO image
151 directdisk-gpt Create a 'pcbios' direct disk image 151 directdisk-gpt Create a 'pcbios' direct disk image
152 systemd-bootdisk Create an EFI disk image with systemd-boot 152 systemd-bootdisk Create an EFI disk image with systemd-boot
153 sdimage-bootpart Create SD card image with a boot partition 153 sdimage-bootpart Create SD card image with a boot partition
154 qemux86-directdisk Create a qemu machine 'pcbios' direct disk image 154 qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
155 directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config 155 directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
156 156
157Once you know the list of available 157Once you know the list of available
158Wic images, you can use ``help`` with the command to get help on a 158Wic images, you can use ``help`` with the command to get help on a
@@ -282,20 +282,20 @@ following two locations::
282Use the following command to list the available kickstart files:: 282Use the following command to list the available kickstart files::
283 283
284 $ wic list images 284 $ wic list images
285 genericx86 Create an EFI disk image for genericx86* 285 genericx86 Create an EFI disk image for genericx86*
286 beaglebone-yocto Create SD card image for Beaglebone 286 beaglebone-yocto Create SD card image for Beaglebone
287 qemuriscv Create qcow2 image for RISC-V QEMU machines 287 qemuriscv Create qcow2 image for RISC-V QEMU machines
288 mkefidisk Create an EFI disk image 288 mkefidisk Create an EFI disk image
289 qemuloongarch Create qcow2 image for LoongArch QEMU machines 289 qemuloongarch Create qcow2 image for LoongArch QEMU machines
290 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin 290 directdisk-multi-rootfs Create multi rootfs image using rootfs plugin
291 directdisk Create a 'pcbios' direct disk image 291 directdisk Create a 'pcbios' direct disk image
292 efi-bootdisk 292 efi-bootdisk
293 mkhybridiso Create a hybrid ISO image 293 mkhybridiso Create a hybrid ISO image
294 directdisk-gpt Create a 'pcbios' direct disk image 294 directdisk-gpt Create a 'pcbios' direct disk image
295 systemd-bootdisk Create an EFI disk image with systemd-boot 295 systemd-bootdisk Create an EFI disk image with systemd-boot
296 sdimage-bootpart Create SD card image with a boot partition 296 sdimage-bootpart Create SD card image with a boot partition
297 qemux86-directdisk Create a qemu machine 'pcbios' direct disk image 297 qemux86-directdisk Create a qemu machine 'pcbios' direct disk image
298 directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config 298 directdisk-bootloader-config Create a 'pcbios' direct disk image with custom bootloader config
299 299
300When you use an existing file, you 300When you use an existing file, you
301do not have to use the ``.wks`` extension. Here is an example in Raw 301do not have to use the ``.wks`` extension. Here is an example in Raw
diff --git a/documentation/kernel-dev/advanced.rst b/documentation/kernel-dev/advanced.rst
index bcaaaeed14..4c463503f6 100644
--- a/documentation/kernel-dev/advanced.rst
+++ b/documentation/kernel-dev/advanced.rst
@@ -303,8 +303,8 @@ The following listings show the ``build.scc`` file and part of the
303 . 303 .
304 . 304 .
305 . 305 .
306 char *dump_write = NULL, *files_source = NULL; 306 char *dump_write = NULL, *files_source = NULL;
307 int opt; 307 int opt;
308 -- 308 --
309 2.10.1 309 2.10.1
310 310
diff --git a/documentation/kernel-dev/common.rst b/documentation/kernel-dev/common.rst
index 9a7a1907f6..fda41694dc 100644
--- a/documentation/kernel-dev/common.rst
+++ b/documentation/kernel-dev/common.rst
@@ -1668,10 +1668,10 @@ looks much like the one provided with the ``hello-mod`` template::
1668 SRC := $(shell pwd) 1668 SRC := $(shell pwd)
1669 1669
1670 all: 1670 all:
1671 $(MAKE) -C $(KERNEL_SRC) M=$(SRC) 1671 $(MAKE) -C $(KERNEL_SRC) M=$(SRC)
1672 1672
1673 modules_install: 1673 modules_install:
1674 $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install 1674 $(MAKE) -C $(KERNEL_SRC) M=$(SRC) modules_install
1675 ... 1675 ...
1676 1676
1677The important point to note here is the :term:`KERNEL_SRC` variable. The 1677The important point to note here is the :term:`KERNEL_SRC` variable. The
diff --git a/documentation/profile-manual/usage.rst b/documentation/profile-manual/usage.rst
index e9705ebf99..17be149580 100644
--- a/documentation/profile-manual/usage.rst
+++ b/documentation/profile-manual/usage.rst
@@ -1058,13 +1058,13 @@ section::
1058 name: do_fork 1058 name: do_fork
1059 ID: 944 1059 ID: 944
1060 format: 1060 format:
1061 field:unsigned short common_type; offset:0; size:2; signed:0; 1061 field:unsigned short common_type; offset:0; size:2; signed:0;
1062 field:unsigned char common_flags; offset:2; size:1; signed:0; 1062 field:unsigned char common_flags; offset:2; size:1; signed:0;
1063 field:unsigned char common_preempt_count; offset:3; size:1; signed:0; 1063 field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
1064 field:int common_pid; offset:4; size:4; signed:1; 1064 field:int common_pid; offset:4; size:4; signed:1;
1065 field:int common_padding; offset:8; size:4; signed:1; 1065 field:int common_padding; offset:8; size:4; signed:1;
1066 1066
1067 field:unsigned long __probe_ip; offset:12; size:4; signed:0; 1067 field:unsigned long __probe_ip; offset:12; size:4; signed:0;
1068 1068
1069 print fmt: "(%lx)", REC->__probe_ip 1069 print fmt: "(%lx)", REC->__probe_ip
1070 1070
@@ -1550,17 +1550,17 @@ like ftrace to display the event as text. The format of the
1550 name: kmalloc 1550 name: kmalloc
1551 ID: 313 1551 ID: 313
1552 format: 1552 format:
1553 field:unsigned short common_type; offset:0; size:2; signed:0; 1553 field:unsigned short common_type; offset:0; size:2; signed:0;
1554 field:unsigned char common_flags; offset:2; size:1; signed:0; 1554 field:unsigned char common_flags; offset:2; size:1; signed:0;
1555 field:unsigned char common_preempt_count; offset:3; size:1; signed:0; 1555 field:unsigned char common_preempt_count; offset:3; size:1; signed:0;
1556 field:int common_pid; offset:4; size:4; signed:1; 1556 field:int common_pid; offset:4; size:4; signed:1;
1557 field:int common_padding; offset:8; size:4; signed:1; 1557 field:int common_padding; offset:8; size:4; signed:1;
1558 1558
1559 field:unsigned long call_site; offset:16; size:8; signed:0; 1559 field:unsigned long call_site; offset:16; size:8; signed:0;
1560 field:const void * ptr; offset:24; size:8; signed:0; 1560 field:const void * ptr; offset:24; size:8; signed:0;
1561 field:size_t bytes_req; offset:32; size:8; signed:0; 1561 field:size_t bytes_req; offset:32; size:8; signed:0;
1562 field:size_t bytes_alloc; offset:40; size:8; signed:0; 1562 field:size_t bytes_alloc; offset:40; size:8; signed:0;
1563 field:gfp_t gfp_flags; offset:48; size:4; signed:0; 1563 field:gfp_t gfp_flags; offset:48; size:4; signed:0;
1564 1564
1565 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, 1565 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,
1566 (REC->gfp_flags) ? __print_flags(REC->gfp_flags, "|", {(unsigned long)(((( gfp_t)0x10u) | (( gfp_t)0x40u) | (( gfp_t)0x80u) | (( 1566 (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::
2355 8,32 1 0 58.516990819 0 m N cfq3551 put_queue 2355 8,32 1 0 58.516990819 0 m N cfq3551 put_queue
2356 2356
2357 CPU0 (sdc): 2357 CPU0 (sdc):
2358 Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB 2358 Reads Queued: 0, 0KiB Writes Queued: 331, 26,284KiB
2359 Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB 2359 Read Dispatches: 0, 0KiB Write Dispatches: 485, 40,484KiB
2360 Reads Requeued: 0 Writes Requeued: 0 2360 Reads Requeued: 0 Writes Requeued: 0
2361 Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB 2361 Reads Completed: 0, 0KiB Writes Completed: 511, 41,000KiB
2362 Read Merges: 0, 0KiB Write Merges: 13, 160KiB 2362 Read Merges: 0, 0KiB Write Merges: 13, 160KiB
2363 Read depth: 0 Write depth: 2 2363 Read depth: 0 Write depth: 2
2364 IO unplugs: 23 Timer unplugs: 0 2364 IO unplugs: 23 Timer unplugs: 0
2365 CPU1 (sdc): 2365 CPU1 (sdc):
2366 Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB 2366 Reads Queued: 0, 0KiB Writes Queued: 249, 15,800KiB
2367 Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB 2367 Read Dispatches: 0, 0KiB Write Dispatches: 42, 1,600KiB
2368 Reads Requeued: 0 Writes Requeued: 0 2368 Reads Requeued: 0 Writes Requeued: 0
2369 Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB 2369 Reads Completed: 0, 0KiB Writes Completed: 16, 1,084KiB
2370 Read Merges: 0, 0KiB Write Merges: 40, 276KiB 2370 Read Merges: 0, 0KiB Write Merges: 40, 276KiB
2371 Read depth: 0 Write depth: 2 2371 Read depth: 0 Write depth: 2
2372 IO unplugs: 30 Timer unplugs: 1 2372 IO unplugs: 30 Timer unplugs: 1
2373 2373
2374 Total (sdc): 2374 Total (sdc):
2375 Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB 2375 Reads Queued: 0, 0KiB Writes Queued: 580, 42,084KiB
2376 Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB 2376 Read Dispatches: 0, 0KiB Write Dispatches: 527, 42,084KiB
2377 Reads Requeued: 0 Writes Requeued: 0 2377 Reads Requeued: 0 Writes Requeued: 0
2378 Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB 2378 Reads Completed: 0, 0KiB Writes Completed: 527, 42,084KiB
2379 Read Merges: 0, 0KiB Write Merges: 53, 436KiB 2379 Read Merges: 0, 0KiB Write Merges: 53, 436KiB
2380 IO unplugs: 53 Timer unplugs: 1 2380 IO unplugs: 53 Timer unplugs: 1
2381 2381
2382 Throughput (R/W): 0KiB/s / 719KiB/s 2382 Throughput (R/W): 0KiB/s / 719KiB/s
2383 Events (sdc): 6,592 entries 2383 Events (sdc): 6,592 entries
@@ -2500,29 +2500,29 @@ And run blkparse on the host system using the device name::
2500 8,32 1 0 177.266696560 0 m N cfq1267 put_queue 2500 8,32 1 0 177.266696560 0 m N cfq1267 put_queue
2501 2501
2502 CPU0 (sdc): 2502 CPU0 (sdc):
2503 Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB 2503 Reads Queued: 0, 0KiB Writes Queued: 270, 21,708KiB
2504 Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB 2504 Read Dispatches: 59, 2,628KiB Write Dispatches: 495, 39,964KiB
2505 Reads Requeued: 0 Writes Requeued: 0 2505 Reads Requeued: 0 Writes Requeued: 0
2506 Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB 2506 Reads Completed: 90, 2,752KiB Writes Completed: 543, 41,596KiB
2507 Read Merges: 0, 0KiB Write Merges: 9, 344KiB 2507 Read Merges: 0, 0KiB Write Merges: 9, 344KiB
2508 Read depth: 2 Write depth: 2 2508 Read depth: 2 Write depth: 2
2509 IO unplugs: 20 Timer unplugs: 1 2509 IO unplugs: 20 Timer unplugs: 1
2510 CPU1 (sdc): 2510 CPU1 (sdc):
2511 Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB 2511 Reads Queued: 688, 2,752KiB Writes Queued: 381, 20,652KiB
2512 Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB 2512 Read Dispatches: 31, 124KiB Write Dispatches: 59, 2,396KiB
2513 Reads Requeued: 0 Writes Requeued: 0 2513 Reads Requeued: 0 Writes Requeued: 0
2514 Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB 2514 Reads Completed: 0, 0KiB Writes Completed: 11, 764KiB
2515 Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB 2515 Read Merges: 598, 2,392KiB Write Merges: 88, 448KiB
2516 Read depth: 2 Write depth: 2 2516 Read depth: 2 Write depth: 2
2517 IO unplugs: 52 Timer unplugs: 0 2517 IO unplugs: 52 Timer unplugs: 0
2518 2518
2519 Total (sdc): 2519 Total (sdc):
2520 Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB 2520 Reads Queued: 688, 2,752KiB Writes Queued: 651, 42,360KiB
2521 Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB 2521 Read Dispatches: 90, 2,752KiB Write Dispatches: 554, 42,360KiB
2522 Reads Requeued: 0 Writes Requeued: 0 2522 Reads Requeued: 0 Writes Requeued: 0
2523 Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB 2523 Reads Completed: 90, 2,752KiB Writes Completed: 554, 42,360KiB
2524 Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB 2524 Read Merges: 598, 2,392KiB Write Merges: 97, 792KiB
2525 IO unplugs: 72 Timer unplugs: 1 2525 IO unplugs: 72 Timer unplugs: 1
2526 2526
2527 Throughput (R/W): 15KiB/s / 238KiB/s 2527 Throughput (R/W): 15KiB/s / 238KiB/s
2528 Events (sdc): 9,301 entries 2528 Events (sdc): 9,301 entries
diff --git a/documentation/ref-manual/terms.rst b/documentation/ref-manual/terms.rst
index ad9c46c339..b18c4183b6 100644
--- a/documentation/ref-manual/terms.rst
+++ b/documentation/ref-manual/terms.rst
@@ -228,23 +228,23 @@ universal, the list includes them just in case:
228 228
229 As far as bootloaders are concerned, :term:`Initramfs` and "initrd" 229 As far as bootloaders are concerned, :term:`Initramfs` and "initrd"
230 images are still copied to RAM in the same way. That's why most 230 images are still copied to RAM in the same way. That's why most
231 most bootloaders refer to :term:`Initramfs` images as "initrd" 231 most bootloaders refer to :term:`Initramfs` images as "initrd"
232 or "init RAM disk". 232 or "init RAM disk".
233 233
234 This kind of mechanism is typically used for two reasons: 234 This kind of mechanism is typically used for two reasons:
235 235
236 - For booting the same kernel binary on multiple systems requiring 236 - For booting the same kernel binary on multiple systems requiring
237 different device drivers. The :term:`Initramfs` image is then customized 237 different device drivers. The :term:`Initramfs` image is then customized
238 for each type of system, to include the specific kernel modules 238 for each type of system, to include the specific kernel modules
239 necessary to access the final root filesystem. This technique 239 necessary to access the final root filesystem. This technique
240 is used on all GNU / Linux distributions for desktops and servers. 240 is used on all GNU / Linux distributions for desktops and servers.
241 241
242 - For booting faster. As the root filesystem is extracted into RAM, 242 - For booting faster. As the root filesystem is extracted into RAM,
243 accessing the first user-space applications is very fast, compared 243 accessing the first user-space applications is very fast, compared
244 to having to initialize a block device, to access multiple blocks 244 to having to initialize a block device, to access multiple blocks
245 from it, and to go through a filesystem having its own overhead. 245 from it, and to go through a filesystem having its own overhead.
246 For example, this allows to display a splashscreen very early, 246 For example, this allows to display a splashscreen very early,
247 and to later take care of mounting the final root filesystem and 247 and to later take care of mounting the final root filesystem and
248 loading less time-critical kernel drivers. 248 loading less time-critical kernel drivers.
249 249
250 This cpio archive can either be loaded to RAM by the bootloader, 250 This cpio archive can either be loaded to RAM by the bootloader,
diff --git a/documentation/sdk-manual/working-projects.rst b/documentation/sdk-manual/working-projects.rst
index b9af33393b..4236bcec24 100644
--- a/documentation/sdk-manual/working-projects.rst
+++ b/documentation/sdk-manual/working-projects.rst
@@ -295,12 +295,12 @@ example:
295 all: main.o module.o 295 all: main.o module.o
296 ${CC} main.o module.o -o target_bin 296 ${CC} main.o module.o -o target_bin
297 main.o: main.c module.h 297 main.o: main.c module.h
298 ${CC} -I . -c main.c 298 ${CC} -I . -c main.c
299 module.o: module.c module.h 299 module.o: module.c module.h
300 ${CC} -I . -c module.c 300 ${CC} -I . -c module.c
301 clean: 301 clean:
302 rm -rf *.o 302 rm -rf *.o
303 rm target_bin 303 rm target_bin
304 304
305#. *Make the Project:* Use the ``make`` command to create the binary 305#. *Make the Project:* Use the ``make`` command to create the binary
306 output file. Because variables are commented out in the Makefile, the 306 output file. Because variables are commented out in the Makefile, the