diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2023-01-05 08:34:26 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2023-01-06 17:39:09 +0000 |
commit | 8b1909aa6f7a51a878dc3d4a9223403ad3e164a9 (patch) | |
tree | e1418f545ad6640afb5fde004696eef2a9e6e67b /documentation/ref-manual/qa-checks.rst | |
parent | ae280972ffba62d7ed839b692957f61b0955cbca (diff) | |
download | poky-8b1909aa6f7a51a878dc3d4a9223403ad3e164a9.tar.gz |
manuals: simplify references to classes
Now that .bbclass is removed from class section titles.
We can now have, for example, :ref:`ref-classes-insane`
instead of :ref:`insane <ref-classes-insane>`.
Then, when necessary, rework paragraphs so that they
have lines of even length, not exceeding 80 characters.
(From yocto-docs rev: e76190e3be78c1e483bec0469f1e437dbf8f3791)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Suggested-by: Quentin Schulz <foss+yocto@0leil.net>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/qa-checks.rst')
-rw-r--r-- | documentation/ref-manual/qa-checks.rst | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index 798d4be4cf..13096816d2 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
@@ -580,7 +580,7 @@ Errors and Warnings | |||
580 | 580 | ||
581 | The specified package contains mime type files (``.xml`` files in | 581 | The specified package contains mime type files (``.xml`` files in |
582 | ``${datadir}/mime/packages``) and yet does not inherit the | 582 | ``${datadir}/mime/packages``) and yet does not inherit the |
583 | :ref:`mime <ref-classes-mime>` class which will ensure that these get | 583 | :ref:`ref-classes-mime` class which will ensure that these get |
584 | properly installed. Either add ``inherit mime`` to the recipe or remove the | 584 | properly installed. Either add ``inherit mime`` to the recipe or remove the |
585 | files at the :ref:`ref-tasks-install` step if they are not needed. | 585 | files at the :ref:`ref-tasks-install` step if they are not needed. |
586 | 586 | ||
@@ -590,7 +590,7 @@ Errors and Warnings | |||
590 | - ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: <packagename> path '<file>' [mime-xdg]`` | 590 | - ``package contains desktop file with key 'MimeType' but does not inhert mime-xdg: <packagename> path '<file>' [mime-xdg]`` |
591 | 591 | ||
592 | The specified package contains a .desktop file with a 'MimeType' key | 592 | The specified package contains a .desktop file with a 'MimeType' key |
593 | present, but does not inherit the :ref:`mime-xdg <ref-classes-mime-xdg>` | 593 | present, but does not inherit the :ref:`ref-classes-mime-xdg` |
594 | class that is required in order for that to be activated. Either add | 594 | class that is required in order for that to be activated. Either add |
595 | ``inherit mime`` to the recipe or remove the files at the | 595 | ``inherit mime`` to the recipe or remove the files at the |
596 | :ref:`ref-tasks-install` step if they are not needed. | 596 | :ref:`ref-tasks-install` step if they are not needed. |
@@ -621,9 +621,9 @@ Errors and Warnings | |||
621 | - ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` | 621 | - ``<recipename>: recipe doesn't inherit features_check [unhandled-features-check]`` |
622 | 622 | ||
623 | This check ensures that if one of the variables that the | 623 | This check ensures that if one of the variables that the |
624 | :ref:`features_check <ref-classes-features_check>` class supports (e.g. | 624 | :ref:`ref-classes-features_check` class supports (e.g. |
625 | :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe | 625 | :term:`REQUIRED_DISTRO_FEATURES`) is used, then the recipe |
626 | inherits :ref:`features_check <ref-classes-features_check>` in order for | 626 | inherits :ref:`ref-classes-features_check` in order for |
627 | the requirement to actually work. If you are seeing this message, either | 627 | the requirement to actually work. If you are seeing this message, either |
628 | add ``inherit features_check`` to your recipe or remove the reference to | 628 | add ``inherit features_check`` to your recipe or remove the reference to |
629 | the variable if it is not needed. | 629 | the variable if it is not needed. |
@@ -634,7 +634,7 @@ Errors and Warnings | |||
634 | - ``<recipename>: recipe defines ALTERNATIVE:<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]`` | 634 | - ``<recipename>: recipe defines ALTERNATIVE:<packagename> but doesn't inherit update-alternatives. This might fail during do_rootfs later! [missing-update-alternatives]`` |
635 | 635 | ||
636 | This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the | 636 | This check ensures that if a recipe sets the :term:`ALTERNATIVE` variable that the |
637 | recipe also inherits :ref:`update-alternatives <ref-classes-update-alternatives>` such | 637 | recipe also inherits :ref:`ref-classes-update-alternatives` such |
638 | that the alternative will be correctly set up. If you are seeing this message, either | 638 | that the alternative will be correctly set up. If you are seeing this message, either |
639 | add ``inherit update-alternatives`` to your recipe or remove the reference to the variable | 639 | add ``inherit update-alternatives`` to your recipe or remove the reference to the variable |
640 | if it is not needed. | 640 | if it is not needed. |
@@ -655,7 +655,7 @@ Errors and Warnings | |||
655 | - ``<packagename> contains perllocal.pod (<files>), should not be installed [perllocalpod]`` | 655 | - ``<packagename> contains perllocal.pod (<files>), should not be installed [perllocalpod]`` |
656 | 656 | ||
657 | ``perllocal.pod`` is an index file of locally installed modules and so shouldn't be | 657 | ``perllocal.pod`` is an index file of locally installed modules and so shouldn't be |
658 | installed by any distribution packages. The :ref:`cpan <ref-classes-cpan>` class | 658 | installed by any distribution packages. The :ref:`ref-classes-cpan` class |
659 | already sets ``NO_PERLLOCAL`` to stop this file being generated by most Perl recipes, | 659 | already sets ``NO_PERLLOCAL`` to stop this file being generated by most Perl recipes, |
660 | but if a recipe is using ``MakeMaker`` directly then they might not be doing this | 660 | but if a recipe is using ``MakeMaker`` directly then they might not be doing this |
661 | correctly. This check ensures that perllocal.pod is not in any package in order to | 661 | correctly. This check ensures that perllocal.pod is not in any package in order to |