diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2022-10-31 14:18:30 +0100 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2022-11-07 21:31:32 +0000 |
commit | 1d2681fa729c95ee75f3fc5608c97134afecb1ce (patch) | |
tree | 6d65f2629146a5280dc01e07a098a4dbf6ff0b97 /documentation | |
parent | 0eae6282163e15d34b7d6af88a984bbc8d6e79e2 (diff) | |
download | poky-1d2681fa729c95ee75f3fc5608c97134afecb1ce.tar.gz |
manuals: document "mime-xdg" class and MIME_XDG_PACKAGES
(From yocto-docs rev: dabd2e95cf8ba8ed620bfd135deb6cfcf5d74b16)
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/migration-guides/migration-3.1.rst | 2 | ||||
-rw-r--r-- | documentation/ref-manual/classes.rst | 21 | ||||
-rw-r--r-- | documentation/ref-manual/qa-checks.rst | 8 | ||||
-rw-r--r-- | documentation/ref-manual/variables.rst | 7 |
4 files changed, 33 insertions, 5 deletions
diff --git a/documentation/migration-guides/migration-3.1.rst b/documentation/migration-guides/migration-3.1.rst index a6106eefae..7fdd3b88a6 100644 --- a/documentation/migration-guides/migration-3.1.rst +++ b/documentation/migration-guides/migration-3.1.rst | |||
@@ -238,7 +238,7 @@ Warnings will now be shown at :ref:`ref-tasks-package_qa` time in the following | |||
238 | circumstances: | 238 | circumstances: |
239 | 239 | ||
240 | - A recipe installs ``.desktop`` files containing ``MimeType`` keys but | 240 | - A recipe installs ``.desktop`` files containing ``MimeType`` keys but |
241 | does not inherit the new ``mime-xdg`` class | 241 | does not inherit the new :ref:`mime-xdg <ref-classes-mime-xdg>` class |
242 | 242 | ||
243 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` | 243 | - A recipe installs ``.xml`` files into ``${datadir}/mime/packages`` |
244 | but does not inherit the :ref:`mime <ref-classes-mime>` class | 244 | but does not inherit the :ref:`mime <ref-classes-mime>` class |
diff --git a/documentation/ref-manual/classes.rst b/documentation/ref-manual/classes.rst index 5537eb774a..0d3d2586b4 100644 --- a/documentation/ref-manual/classes.rst +++ b/documentation/ref-manual/classes.rst | |||
@@ -1604,6 +1604,27 @@ The :ref:`mime <ref-classes-mime>` class generates the proper post-install and p | |||
1604 | These scriptlets call ``update-mime-database`` to add the MIME types to | 1604 | These scriptlets call ``update-mime-database`` to add the MIME types to |
1605 | the shared database. | 1605 | the shared database. |
1606 | 1606 | ||
1607 | .. _ref-classes-mime-xdg: | ||
1608 | |||
1609 | ``mime-xdg.bbclass`` | ||
1610 | ==================== | ||
1611 | |||
1612 | The :ref:`mime-xdg <ref-classes-mime-xdg>` class generates the proper | ||
1613 | post-install and post-remove (postinst/postrm) scriptlets for packages | ||
1614 | that install ``.desktop`` files containing ``MimeType`` entries. | ||
1615 | These scriptlets call ``update-desktop-database`` to add the MIME types | ||
1616 | to the database of MIME types handled by desktop files. | ||
1617 | |||
1618 | Thanks to this class, when users open a file through a file browser | ||
1619 | on recently created images, they don't have to choose the application | ||
1620 | to open the file from the pool of all known applications, even the ones | ||
1621 | that cannot open the selected file. | ||
1622 | |||
1623 | If you have recipes installing their ``.desktop`` files as absolute | ||
1624 | symbolic links, the detection of such files cannot be done by the current | ||
1625 | implementation of this class. In this case, you have to add the corresponding | ||
1626 | package names to the :term:`MIME_XDG_PACKAGES` variable. | ||
1627 | |||
1607 | .. _ref-classes-mirrors: | 1628 | .. _ref-classes-mirrors: |
1608 | 1629 | ||
1609 | ``mirrors.bbclass`` | 1630 | ``mirrors.bbclass`` |
diff --git a/documentation/ref-manual/qa-checks.rst b/documentation/ref-manual/qa-checks.rst index fb31dc16f9..3947dcfc17 100644 --- a/documentation/ref-manual/qa-checks.rst +++ b/documentation/ref-manual/qa-checks.rst | |||
@@ -590,10 +590,10 @@ 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 mime-xdg class that is required in | 593 | present, but does not inherit the :ref:`mime-xdg <ref-classes-mime-xdg>` |
594 | order for that to be activated. Either add ``inherit mime`` to the | 594 | class that is required in order for that to be activated. Either add |
595 | recipe or remove the files at the :ref:`ref-tasks-install` step if they are not | 595 | ``inherit mime`` to the recipe or remove the files at the |
596 | needed. | 596 | :ref:`ref-tasks-install` step if they are not needed. |
597 | 597 | ||
598 | 598 | ||
599 | .. _qa-check-src-uri-bad: | 599 | .. _qa-check-src-uri-bad: |
diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index 0cc73a234c..440e1a0833 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst | |||
@@ -4894,6 +4894,13 @@ system and gives an overview of their function and contents. | |||
4894 | The revision currently checked out for the OpenEmbedded-Core layer (path | 4894 | The revision currently checked out for the OpenEmbedded-Core layer (path |
4895 | determined by :term:`COREBASE`). | 4895 | determined by :term:`COREBASE`). |
4896 | 4896 | ||
4897 | :term:`MIME_XDG_PACKAGES` | ||
4898 | The current implementation of the :ref:`mime-xdg <ref-classes-mime-xdg>` | ||
4899 | class cannot detect ``.desktop`` files installed through absolute | ||
4900 | symbolic links. Use this setting to make the class create post-install | ||
4901 | and post-remove scripts for these packages anyway, to invoke the | ||
4902 | ``update-destop-database`` command. | ||
4903 | |||
4897 | :term:`MIRRORS` | 4904 | :term:`MIRRORS` |
4898 | Specifies additional paths from which the OpenEmbedded build system | 4905 | Specifies additional paths from which the OpenEmbedded build system |
4899 | gets source code. When the build system searches for source code, it | 4906 | gets source code. When the build system searches for source code, it |