diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst index 8bd82223f2..ed6b1446f3 100644 --- a/documentation/dev-manual/common-tasks.rst +++ b/documentation/dev-manual/common-tasks.rst @@ -4949,8 +4949,7 @@ the x32 psABI. Here is an example:: Enabling GObject Introspection Support ====================================== -`GObject -introspection `__ +`GObject introspection `__ is the standard mechanism for accessing GObject-based software from runtime environments. GObject is a feature of the GLib library that provides an object framework for the GNOME desktop and related software. @@ -4962,7 +4961,7 @@ introspection is the only way to do it. This section describes the Yocto Project support for generating and packaging GObject introspection data. GObject introspection data is a -description of the API provided by libraries built on top of GLib +description of the API provided by libraries built on top of the GLib framework, and, in particular, that framework's GObject mechanism. GObject Introspection Repository (GIR) files go to ``-dev`` packages, ``typelib`` files go to main packages as they are packaged together with @@ -5008,7 +5007,7 @@ library package involves the following: .. note:: See recipes in the ``oe-core`` repository that use that - ``GIR_EXTRA_LIBS_PATH`` variable as an example. + :term:`GIR_EXTRA_LIBS_PATH` variable as an example. 4. Look for any other errors, which probably mean that introspection support in a package is not entirely standard, and thus breaks down diff --git a/documentation/ref-manual/variables.rst b/documentation/ref-manual/variables.rst index e81a12030a..be496161bd 100644 --- a/documentation/ref-manual/variables.rst +++ b/documentation/ref-manual/variables.rst @@ -2667,6 +2667,13 @@ system and gives an overview of their function and contents. :term:`GDB` The minimal command and arguments to run the GNU Debugger. + :term:`GIR_EXTRA_LIBS_PATH` + Allows to specify an extra search path for ``.so`` files + in GLib related recipes using GObject introspection, + and which do not compile without this setting. + See the ":ref:`dev-manual/common-tasks:enabling gobject introspection support`" + section for details. + :term:`GITDIR` The directory in which a local copy of a Git repository is stored when it is cloned.