diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-03-29 15:07:47 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-03-30 13:05:03 +0100 |
commit | 6d668da03095db4a584d71c93319445f2806445a (patch) | |
tree | b61ff68a44ba3a6abf99e55b154ef9e2e98909c3 /bitbake | |
parent | f6cdd19553e794b2036f592d4f240a11444530b5 (diff) | |
download | poky-6d668da03095db4a584d71c93319445f2806445a.tar.gz |
bitbake: bitbake: bitbake-user-manual: punctuation fixes
- Replace hyphens by em dashes when necessary
See https://www.grammarly.com/blog/hyphens-and-dashes/
- No uppercase after em dashes
- No uppercase after colons if what follows is not a
complete sentence.
- Fix spacing before colons ":"
- Replace em-dashes with colons for consistency in a section
(Bitbake rev: 72230d6a9976b3bfca1f1e6fb09736fec195e2fe)
(Bitbake rev: f1c4ac816e927f490fb9852c12aa408e8c9403b1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Alexandre Belloni <alexandre.belloni@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'bitbake')
4 files changed, 37 insertions, 37 deletions
diff --git a/bitbake/doc/README b/bitbake/doc/README index 16e6cdf990..cdbb23776e 100644 --- a/bitbake/doc/README +++ b/bitbake/doc/README | |||
@@ -8,7 +8,7 @@ Manual Organization | |||
8 | 8 | ||
9 | Folders exist for individual manuals as follows: | 9 | Folders exist for individual manuals as follows: |
10 | 10 | ||
11 | * bitbake-user-manual - The BitBake User Manual | 11 | * bitbake-user-manual --- The BitBake User Manual |
12 | 12 | ||
13 | Each folder is self-contained regarding content and figures. | 13 | Each folder is self-contained regarding content and figures. |
14 | 14 | ||
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst index 088eb818d6..7a22e96edf 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-execution.rst | |||
@@ -523,7 +523,7 @@ it cannot figure out dependencies. | |||
523 | Thus far, this section has limited discussion to the direct inputs into | 523 | Thus far, this section has limited discussion to the direct inputs into |
524 | a task. Information based on direct inputs is referred to as the | 524 | a task. Information based on direct inputs is referred to as the |
525 | "basehash" in the code. However, there is still the question of a task's | 525 | "basehash" in the code. However, there is still the question of a task's |
526 | indirect inputs - the things that were already built and present in the | 526 | indirect inputs --- the things that were already built and present in the |
527 | build directory. The checksum (or signature) for a particular task needs | 527 | build directory. The checksum (or signature) for a particular task needs |
528 | to add the hashes of all the tasks on which the particular task depends. | 528 | to add the hashes of all the tasks on which the particular task depends. |
529 | Choosing which dependencies to add is a policy decision. However, the | 529 | Choosing which dependencies to add is a policy decision. However, the |
@@ -534,7 +534,7 @@ At the code level, there are a variety of ways both the basehash and the | |||
534 | dependent task hashes can be influenced. Within the BitBake | 534 | dependent task hashes can be influenced. Within the BitBake |
535 | configuration file, we can give BitBake some extra information to help | 535 | configuration file, we can give BitBake some extra information to help |
536 | it construct the basehash. The following statement effectively results | 536 | it construct the basehash. The following statement effectively results |
537 | in a list of global variable dependency excludes - variables never | 537 | in a list of global variable dependency excludes --- variables never |
538 | included in any checksum. This example uses variables from OpenEmbedded | 538 | included in any checksum. This example uses variables from OpenEmbedded |
539 | to help illustrate the concept:: | 539 | to help illustrate the concept:: |
540 | 540 | ||
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst index ea42d77ca1..af4b135867 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-metadata.rst | |||
@@ -1658,8 +1658,8 @@ user interfaces: | |||
1658 | 1658 | ||
1659 | .. _variants-class-extension-mechanism: | 1659 | .. _variants-class-extension-mechanism: |
1660 | 1660 | ||
1661 | Variants - Class Extension Mechanism | 1661 | Variants --- Class Extension Mechanism |
1662 | ==================================== | 1662 | ====================================== |
1663 | 1663 | ||
1664 | BitBake supports multiple incarnations of a recipe file via the | 1664 | BitBake supports multiple incarnations of a recipe file via the |
1665 | :term:`BBCLASSEXTEND` variable. | 1665 | :term:`BBCLASSEXTEND` variable. |
diff --git a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst index 96cfdc82da..af4ff9805c 100644 --- a/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst +++ b/bitbake/doc/bitbake-user-manual/bitbake-user-manual-ref-variables.rst | |||
@@ -503,14 +503,14 @@ overview of their function and contents. | |||
503 | Selects the name of the scheduler to use for the scheduling of | 503 | Selects the name of the scheduler to use for the scheduling of |
504 | BitBake tasks. Three options exist: | 504 | BitBake tasks. Three options exist: |
505 | 505 | ||
506 | - *basic* - The basic framework from which everything derives. Using | 506 | - *basic* --- the basic framework from which everything derives. Using |
507 | this option causes tasks to be ordered numerically as they are | 507 | this option causes tasks to be ordered numerically as they are |
508 | parsed. | 508 | parsed. |
509 | 509 | ||
510 | - *speed* - Executes tasks first that have more tasks depending on | 510 | - *speed* --- executes tasks first that have more tasks depending on |
511 | them. The "speed" option is the default. | 511 | them. The "speed" option is the default. |
512 | 512 | ||
513 | - *completion* - Causes the scheduler to try to complete a given | 513 | - *completion* --- causes the scheduler to try to complete a given |
514 | recipe once its build has started. | 514 | recipe once its build has started. |
515 | 515 | ||
516 | :term:`BB_SCHEDULERS` | 516 | :term:`BB_SCHEDULERS` |
@@ -557,10 +557,10 @@ overview of their function and contents. | |||
557 | 557 | ||
558 | The variable can be set using one of two policies: | 558 | The variable can be set using one of two policies: |
559 | 559 | ||
560 | - *cache* - Retains the value the system obtained previously rather | 560 | - *cache* --- retains the value the system obtained previously rather |
561 | than querying the source control system each time. | 561 | than querying the source control system each time. |
562 | 562 | ||
563 | - *clear* - Queries the source controls system every time. With this | 563 | - *clear* --- queries the source controls system every time. With this |
564 | policy, there is no cache. The "clear" policy is the default. | 564 | policy, there is no cache. The "clear" policy is the default. |
565 | 565 | ||
566 | :term:`BB_STRICT_CHECKSUM` | 566 | :term:`BB_STRICT_CHECKSUM` |
@@ -686,7 +686,7 @@ overview of their function and contents. | |||
686 | This variable is useful in situations where the same recipe appears | 686 | This variable is useful in situations where the same recipe appears |
687 | in more than one layer. Setting this variable allows you to | 687 | in more than one layer. Setting this variable allows you to |
688 | prioritize a layer against other layers that contain the same recipe | 688 | prioritize a layer against other layers that contain the same recipe |
689 | - effectively letting you control the precedence for the multiple | 689 | --- effectively letting you control the precedence for the multiple |
690 | layers. The precedence established through this variable stands | 690 | layers. The precedence established through this variable stands |
691 | regardless of a recipe's version (:term:`PV` variable). | 691 | regardless of a recipe's version (:term:`PV` variable). |
692 | For example, a layer that has a recipe with a higher :term:`PV` value but | 692 | For example, a layer that has a recipe with a higher :term:`PV` value but |
@@ -1331,7 +1331,7 @@ overview of their function and contents. | |||
1331 | The section in which packages should be categorized. | 1331 | The section in which packages should be categorized. |
1332 | 1332 | ||
1333 | :term:`SRC_URI` | 1333 | :term:`SRC_URI` |
1334 | The list of source files - local or remote. This variable tells | 1334 | The list of source files --- local or remote. This variable tells |
1335 | BitBake which bits to pull for the build and how to pull them. For | 1335 | BitBake which bits to pull for the build and how to pull them. For |
1336 | example, if the recipe or append file needs to fetch a single tarball | 1336 | example, if the recipe or append file needs to fetch a single tarball |
1337 | from the Internet, the recipe or append file uses a :term:`SRC_URI` | 1337 | from the Internet, the recipe or append file uses a :term:`SRC_URI` |
@@ -1347,17 +1347,17 @@ overview of their function and contents. | |||
1347 | the :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` | 1347 | the :ref:`bitbake-user-manual/bitbake-user-manual-fetching:fetchers` |
1348 | section. | 1348 | section. |
1349 | 1349 | ||
1350 | - ``az://`` : Fetches files from an Azure Storage account using HTTPS. | 1350 | - ``az://``: Fetches files from an Azure Storage account using HTTPS. |
1351 | 1351 | ||
1352 | - ``bzr://`` : Fetches files from a Bazaar revision control | 1352 | - ``bzr://``: Fetches files from a Bazaar revision control |
1353 | repository. | 1353 | repository. |
1354 | 1354 | ||
1355 | - ``ccrc://`` - Fetches files from a ClearCase repository. | 1355 | - ``ccrc://``: Fetches files from a ClearCase repository. |
1356 | 1356 | ||
1357 | - ``cvs://`` : Fetches files from a CVS revision control | 1357 | - ``cvs://``: Fetches files from a CVS revision control |
1358 | repository. | 1358 | repository. |
1359 | 1359 | ||
1360 | - ``file://`` - Fetches files, which are usually files shipped | 1360 | - ``file://``: Fetches files, which are usually files shipped |
1361 | with the Metadata, from the local machine. | 1361 | with the Metadata, from the local machine. |
1362 | The path is relative to the :term:`FILESPATH` | 1362 | The path is relative to the :term:`FILESPATH` |
1363 | variable. Thus, the build system searches, in order, from the | 1363 | variable. Thus, the build system searches, in order, from the |
@@ -1365,51 +1365,51 @@ overview of their function and contents. | |||
1365 | the directory in which the recipe file (``.bb``) or append file | 1365 | the directory in which the recipe file (``.bb``) or append file |
1366 | (``.bbappend``) resides: | 1366 | (``.bbappend``) resides: |
1367 | 1367 | ||
1368 | - ``${BPN}`` - The base recipe name without any special suffix | 1368 | - ``${BPN}``: the base recipe name without any special suffix |
1369 | or version numbers. | 1369 | or version numbers. |
1370 | 1370 | ||
1371 | - ``${BP}`` - ``${BPN}-${PV}``. The base recipe name and | 1371 | - ``${BP}`` - ``${BPN}-${PV}``: the base recipe name and |
1372 | version but without any special package name suffix. | 1372 | version but without any special package name suffix. |
1373 | 1373 | ||
1374 | - *files -* Files within a directory, which is named ``files`` | 1374 | - ``files``: files within a directory, which is named ``files`` |
1375 | and is also alongside the recipe or append file. | 1375 | and is also alongside the recipe or append file. |
1376 | 1376 | ||
1377 | - ``ftp://`` : Fetches files from the Internet using FTP. | 1377 | - ``ftp://``: Fetches files from the Internet using FTP. |
1378 | 1378 | ||
1379 | - ``git://`` : Fetches files from a Git revision control | 1379 | - ``git://``: Fetches files from a Git revision control |
1380 | repository. | 1380 | repository. |
1381 | 1381 | ||
1382 | - ``gitsm://`` : Fetches submodules from a Git revision control | 1382 | - ``gitsm://``: Fetches submodules from a Git revision control |
1383 | repository. | 1383 | repository. |
1384 | 1384 | ||
1385 | - ``hg://`` : Fetches files from a Mercurial (``hg``) revision | 1385 | - ``hg://``: Fetches files from a Mercurial (``hg``) revision |
1386 | control repository. | 1386 | control repository. |
1387 | 1387 | ||
1388 | - ``http://`` : Fetches files from the Internet using HTTP. | 1388 | - ``http://``: Fetches files from the Internet using HTTP. |
1389 | 1389 | ||
1390 | - ``https://`` : Fetches files from the Internet using HTTPS. | 1390 | - ``https://``: Fetches files from the Internet using HTTPS. |
1391 | 1391 | ||
1392 | - ``npm://`` - Fetches JavaScript modules from a registry. | 1392 | - ``npm://``: Fetches JavaScript modules from a registry. |
1393 | 1393 | ||
1394 | - ``osc://`` : Fetches files from an OSC (OpenSUSE Build service) | 1394 | - ``osc://``: Fetches files from an OSC (OpenSUSE Build service) |
1395 | revision control repository. | 1395 | revision control repository. |
1396 | 1396 | ||
1397 | - ``p4://`` : Fetches files from a Perforce (``p4``) revision | 1397 | - ``p4://``: Fetches files from a Perforce (``p4``) revision |
1398 | control repository. | 1398 | control repository. |
1399 | 1399 | ||
1400 | - ``repo://`` : Fetches files from a repo (Git) repository. | 1400 | - ``repo://``: Fetches files from a repo (Git) repository. |
1401 | 1401 | ||
1402 | - ``ssh://`` : Fetches files from a secure shell. | 1402 | - ``ssh://``: Fetches files from a secure shell. |
1403 | 1403 | ||
1404 | - ``svn://`` : Fetches files from a Subversion (``svn``) revision | 1404 | - ``svn://``: Fetches files from a Subversion (``svn``) revision |
1405 | control repository. | 1405 | control repository. |
1406 | 1406 | ||
1407 | Here are some additional options worth mentioning: | 1407 | Here are some additional options worth mentioning: |
1408 | 1408 | ||
1409 | - ``downloadfilename`` : Specifies the filename used when storing | 1409 | - ``downloadfilename``: Specifies the filename used when storing |
1410 | the downloaded file. | 1410 | the downloaded file. |
1411 | 1411 | ||
1412 | - ``name`` - Specifies a name to be used for association with | 1412 | - ``name``: Specifies a name to be used for association with |
1413 | :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one | 1413 | :term:`SRC_URI` checksums or :term:`SRCREV` when you have more than one |
1414 | file or git repository specified in :term:`SRC_URI`. For example:: | 1414 | file or git repository specified in :term:`SRC_URI`. For example:: |
1415 | 1415 | ||
@@ -1421,15 +1421,15 @@ overview of their function and contents. | |||
1421 | SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" | 1421 | SRCREV_second = "e242ed3bffccdf271b7fbaf34ed72d089537b42f" |
1422 | SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" | 1422 | SRC_URI[third.sha256sum] = "13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de" |
1423 | 1423 | ||
1424 | - ``subdir`` : Places the file (or extracts its contents) into the | 1424 | - ``subdir``: Places the file (or extracts its contents) into the |
1425 | specified subdirectory. This option is useful for unusual tarballs | 1425 | specified subdirectory. This option is useful for unusual tarballs |
1426 | or other archives that do not have their files already in a | 1426 | or other archives that do not have their files already in a |
1427 | subdirectory within the archive. | 1427 | subdirectory within the archive. |
1428 | 1428 | ||
1429 | - ``subpath`` - Limits the checkout to a specific subpath of the | 1429 | - ``subpath``: Limits the checkout to a specific subpath of the |
1430 | tree when using the Git fetcher is used. | 1430 | tree when using the Git fetcher is used. |
1431 | 1431 | ||
1432 | - ``unpack`` : Controls whether or not to unpack the file if it is | 1432 | - ``unpack``: Controls whether or not to unpack the file if it is |
1433 | an archive. The default action is to unpack the file. | 1433 | an archive. The default action is to unpack the file. |
1434 | 1434 | ||
1435 | :term:`SRCDATE` | 1435 | :term:`SRCDATE` |