summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual/gobject-introspection.rst
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2022-12-09 19:01:55 +0100
committerRichard Purdie <richard.purdie@linuxfoundation.org>2022-12-18 10:41:21 +0000
commit6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06 (patch)
tree6a59e9936ac9f2ca063d4fc8a5c4d9ecc9492769 /documentation/dev-manual/gobject-introspection.rst
parent474e071608c7c1c97e9dafde810aef5630c716e7 (diff)
downloadpoky-6846d4d00bc3a9d4e188ad9c8cfdf6e45cd1ba06.tar.gz
manuals: define proper numbered lists
Using "#." instead of "1.", "2.", "3.", etc. (From yocto-docs rev: 11c2585acd0fa6c330702af2359ce5a9e47cde1f) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Reported-by: Quentin Schulz <foss+yocto@0leil.net> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/gobject-introspection.rst')
-rw-r--r--documentation/dev-manual/gobject-introspection.rst18
1 files changed, 9 insertions, 9 deletions
diff --git a/documentation/dev-manual/gobject-introspection.rst b/documentation/dev-manual/gobject-introspection.rst
index 89f21b7d10..28e51240c3 100644
--- a/documentation/dev-manual/gobject-introspection.rst
+++ b/documentation/dev-manual/gobject-introspection.rst
@@ -39,11 +39,11 @@ Enabling the Generation of Introspection Data
39Enabling the generation of introspection data (GIR files) in your 39Enabling the generation of introspection data (GIR files) in your
40library package involves the following: 40library package involves the following:
41 41
421. Inherit the 42#. Inherit the
43 :ref:`gobject-introspection <ref-classes-gobject-introspection>` 43 :ref:`gobject-introspection <ref-classes-gobject-introspection>`
44 class. 44 class.
45 45
462. Make sure introspection is not disabled anywhere in the recipe or 46#. Make sure introspection is not disabled anywhere in the recipe or
47 from anything the recipe includes. Also, make sure that 47 from anything the recipe includes. Also, make sure that
48 "gobject-introspection-data" is not in 48 "gobject-introspection-data" is not in
49 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` 49 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
@@ -51,7 +51,7 @@ library package involves the following:
51 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. 51 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
52 In either of these conditions, nothing will happen. 52 In either of these conditions, nothing will happen.
53 53
543. Try to build the recipe. If you encounter build errors that look like 54#. Try to build the recipe. If you encounter build errors that look like
55 something is unable to find ``.so`` libraries, check where these 55 something is unable to find ``.so`` libraries, check where these
56 libraries are located in the source tree and add the following to the 56 libraries are located in the source tree and add the following to the
57 recipe:: 57 recipe::
@@ -63,7 +63,7 @@ library package involves the following:
63 See recipes in the ``oe-core`` repository that use that 63 See recipes in the ``oe-core`` repository that use that
64 :term:`GIR_EXTRA_LIBS_PATH` variable as an example. 64 :term:`GIR_EXTRA_LIBS_PATH` variable as an example.
65 65
664. Look for any other errors, which probably mean that introspection 66#. Look for any other errors, which probably mean that introspection
67 support in a package is not entirely standard, and thus breaks down 67 support in a package is not entirely standard, and thus breaks down
68 in a cross-compilation environment. For such cases, custom-made fixes 68 in a cross-compilation environment. For such cases, custom-made fixes
69 are needed. A good place to ask and receive help in these cases is 69 are needed. A good place to ask and receive help in these cases is
@@ -116,21 +116,21 @@ Testing that Introspection Works in an Image
116Use the following procedure to test if generating introspection data is 116Use the following procedure to test if generating introspection data is
117working in an image: 117working in an image:
118 118
1191. Make sure that "gobject-introspection-data" is not in 119#. Make sure that "gobject-introspection-data" is not in
120 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED` 120 :term:`DISTRO_FEATURES_BACKFILL_CONSIDERED`
121 and that "qemu-usermode" is not in 121 and that "qemu-usermode" is not in
122 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`. 122 :term:`MACHINE_FEATURES_BACKFILL_CONSIDERED`.
123 123
1242. Build ``core-image-sato``. 124#. Build ``core-image-sato``.
125 125
1263. Launch a Terminal and then start Python in the terminal. 126#. Launch a Terminal and then start Python in the terminal.
127 127
1284. Enter the following in the terminal:: 128#. Enter the following in the terminal::
129 129
130 >>> from gi.repository import GLib 130 >>> from gi.repository import GLib
131 >>> GLib.get_host_name() 131 >>> GLib.get_host_name()
132 132
1335. For something a little more advanced, enter the following see: 133#. For something a little more advanced, enter the following see:
134 https://python-gtk-3-tutorial.readthedocs.io/en/latest/introduction.html 134 https://python-gtk-3-tutorial.readthedocs.io/en/latest/introduction.html
135 135
136Known Issues 136Known Issues