summaryrefslogtreecommitdiffstats
path: root/documentation
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-08-11 16:03:08 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-08-14 12:04:24 +0100
commit350197e46a4aa55d432dea0c5509681e6e5a4c0a (patch)
treebeec7df2f04f4e6a65ed6a028e4f172603b04351 /documentation
parentb5f203516b35672e7a1c6ae166e94d095c629352 (diff)
downloadpoky-350197e46a4aa55d432dea0c5509681e6e5a4c0a.tar.gz
Manuals: replace "file name" by "filename"
There are many more instances of "filename" or "filenames" than of "file name" or "file names". The winner takes it all! (From yocto-docs rev: 13ef92bc301166c2e21d2603b2501749248dbe91) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
-rw-r--r--documentation/dev-manual/common-tasks.rst8
-rw-r--r--documentation/migration-guides/migration-1.5.rst2
-rw-r--r--documentation/ref-manual/qa-checks.rst2
-rw-r--r--documentation/ref-manual/variables.rst2
4 files changed, 7 insertions, 7 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 34e978dde1..88d826f33a 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -465,7 +465,7 @@ have to manually merge changes as they occur.
465When you create an append file, you must use the same root name as the 465When you create an append file, you must use the same root name as the
466corresponding recipe file. For example, the append file 466corresponding recipe file. For example, the append file
467``someapp_3.1.bbappend`` must apply to ``someapp_3.1.bb``. This 467``someapp_3.1.bbappend`` must apply to ``someapp_3.1.bb``. This
468means the original recipe and append file names are version 468means the original recipe and append filenames are version
469number-specific. If the corresponding recipe is renamed to update to a 469number-specific. If the corresponding recipe is renamed to update to a
470newer version, you must also rename and possibly update the 470newer version, you must also rename and possibly update the
471corresponding ``.bbappend`` as well. During the build process, BitBake 471corresponding ``.bbappend`` as well. During the build process, BitBake
@@ -6618,7 +6618,7 @@ optional arguments::
6618 instead of the default False which appends them 6618 instead of the default False which appends them
6619 match_path 6619 match_path
6620 match file_regex on the whole relative path to 6620 match file_regex on the whole relative path to
6621 the root rather than just the file name 6621 the root rather than just the filename
6622 aux_files_pattern_verbatim 6622 aux_files_pattern_verbatim
6623 Extra item(s) to be added to FILES for each 6623 Extra item(s) to be added to FILES for each
6624 package, using the actual derived module name 6624 package, using the actual derived module name
@@ -11154,7 +11154,7 @@ way is to use a patch filename that matches the below pattern::
11154 11154
11155As shown in the example above, multiple CVE IDs can appear in a patch filename, 11155As shown in the example above, multiple CVE IDs can appear in a patch filename,
11156but the :ref:`cve-check <ref-classes-cve-check>` class will only consider 11156but the :ref:`cve-check <ref-classes-cve-check>` class will only consider
11157the last CVE ID in the file name as patched. 11157the last CVE ID in the filename as patched.
11158 11158
11159The second way to recognize a patched CVE ID is when a line matching the 11159The second way to recognize a patched CVE ID is when a line matching the
11160below pattern is found in any patch file provided by the recipe:: 11160below pattern is found in any patch file provided by the recipe::
@@ -11180,7 +11180,7 @@ find unpatched CVE IDs.
11180 11180
11181First the code goes through each patch file provided by a recipe. If a valid CVE ID 11181First the code goes through each patch file provided by a recipe. If a valid CVE ID
11182is found in the name of the file, the corresponding CVE is considered as patched. 11182is found in the name of the file, the corresponding CVE is considered as patched.
11183Don't forget that if multiple CVE IDs are found in the file name, only the last 11183Don't forget that if multiple CVE IDs are found in the filename, only the last
11184one is considered. Then, the code looks for ``CVE: CVE-ID`` lines in the patch 11184one is considered. Then, the code looks for ``CVE: CVE-ID`` lines in the patch
11185file. The found CVE IDs are also considered as patched. 11185file. The found CVE IDs are also considered as patched.
11186 11186
diff --git a/documentation/migration-guides/migration-1.5.rst b/documentation/migration-guides/migration-1.5.rst
index e1ba4a9a13..11c821265c 100644
--- a/documentation/migration-guides/migration-1.5.rst
+++ b/documentation/migration-guides/migration-1.5.rst
@@ -144,7 +144,7 @@ Shortened Git ``SRCREV`` Values
144 144
145BitBake will now shorten revisions from Git repositories from the normal 145BitBake will now shorten revisions from Git repositories from the normal
14640 characters down to 10 characters within :term:`SRCPV` 14640 characters down to 10 characters within :term:`SRCPV`
147for improved usability in path and file names. This change should be 147for improved usability in path and filenames. This change should be
148safe within contexts where these revisions are used because the chances 148safe within contexts where these revisions are used because the chances
149of spatially close collisions is very low. Distant collisions are not a 149of spatially close collisions is very low. Distant collisions are not a
150major issue in the way the values are used. 150major issue in the way the values are used.
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst
index d452de4119..c3e40dba5e 100644
--- a/documentation/ref-manual/qa-checks.rst
+++ b/documentation/ref-manual/qa-checks.rst
@@ -539,7 +539,7 @@ Errors and Warnings
539 when a recipe has been renamed. However, if that is not the case, the 539 when a recipe has been renamed. However, if that is not the case, the
540 message might indicate that a private version of a library is being 540 message might indicate that a private version of a library is being
541 erroneously picked up as the provider for a common library. If that 541 erroneously picked up as the provider for a common library. If that
542 is the case, you should add the library's ``.so`` file name to 542 is the case, you should add the library's ``.so`` filename to
543 :term:`PRIVATE_LIBS` in the recipe that provides 543 :term:`PRIVATE_LIBS` in the recipe that provides
544 the private version of the library. 544 the private version of the library.
545 545
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst
index d5df9ae41c..7aecda0174 100644
--- a/documentation/ref-manual/variables.rst
+++ b/documentation/ref-manual/variables.rst
@@ -3155,7 +3155,7 @@ system and gives an overview of their function and contents.
3155 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}" 3155 IMAGE_NAME ?= "${IMAGE_BASENAME}-${MACHINE}${IMAGE_VERSION_SUFFIX}"
3156 3156
3157 :term:`IMAGE_NAME_SUFFIX` 3157 :term:`IMAGE_NAME_SUFFIX`
3158 Suffix used for the image output file name - defaults to ``".rootfs"`` 3158 Suffix used for the image output filename - defaults to ``".rootfs"``
3159 to distinguish the image file from other files created during image 3159 to distinguish the image file from other files created during image
3160 building; however if this suffix is redundant or not desired you can 3160 building; however if this suffix is redundant or not desired you can
3161 clear the value of this variable (set the value to ""). For example, 3161 clear the value of this variable (set the value to ""). For example,