summaryrefslogtreecommitdiffstats
path: root/documentation/ref-manual/ref-features.rst
diff options
context:
space:
mode:
authorRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-14 22:48:44 +0200
committerRichard Purdie <richard.purdie@linuxfoundation.org>2020-09-17 10:09:35 +0100
commit292598164a304a3da3288e6fb8963f13045d1e7f (patch)
treeefedbbdc16cb2e0978a4d40e6a6294e32b0e496f /documentation/ref-manual/ref-features.rst
parentd313d972bf592de77f2af13cb3fc4226247cb1a1 (diff)
downloadpoky-292598164a304a3da3288e6fb8963f13045d1e7f.tar.gz
sphinx: ref-manual links fixes and many other cleanups to import
(From yocto-docs rev: d079e418d5a81610e1f06a7a6ca45dd040c1402e) Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/ref-manual/ref-features.rst')
-rw-r--r--documentation/ref-manual/ref-features.rst28
1 files changed, 13 insertions, 15 deletions
diff --git a/documentation/ref-manual/ref-features.rst b/documentation/ref-manual/ref-features.rst
index 0e901edaeb..ae5a0e3b24 100644
--- a/documentation/ref-manual/ref-features.rst
+++ b/documentation/ref-manual/ref-features.rst
@@ -26,8 +26,11 @@ One method you can use to determine which recipes are checking to see if
26a particular feature is contained or not is to ``grep`` through the 26a particular feature is contained or not is to ``grep`` through the
27:term:`Metadata` for the feature. Here is an example that 27:term:`Metadata` for the feature. Here is an example that
28discovers the recipes whose build is potentially changed based on a 28discovers the recipes whose build is potentially changed based on a
29given feature: $ cd poky $ git grep 29given feature:
30'contains.*MACHINE_FEATURES.*feature' 30::
31
32 $ cd poky
33 $ git grep 'contains.*MACHINE_FEATURES.*feature'
31 34
32.. _ref-features-machine: 35.. _ref-features-machine:
33 36
@@ -115,8 +118,7 @@ metadata:
115- *api-documentation:* Enables generation of API documentation during 118- *api-documentation:* Enables generation of API documentation during
116 recipe builds. The resulting documentation is added to SDK tarballs 119 recipe builds. The resulting documentation is added to SDK tarballs
117 when the ``bitbake -c populate_sdk`` command is used. See the 120 when the ``bitbake -c populate_sdk`` command is used. See the
118 "`Adding API Documentation to the Standard 121 ":ref:`sdk-manual/sdk-appendix-customizing-standard:adding api documentation to the standard sdk`"
119 SDK <&YOCTO_DOCS_SDK_URL;#adding-api-documentation-to-the-standard-sdk>`__"
120 section in the Yocto Project Application Development and the 122 section in the Yocto Project Application Development and the
121 Extensible Software Development Kit (eSDK) manual. 123 Extensible Software Development Kit (eSDK) manual.
122 124
@@ -154,8 +156,7 @@ metadata:
154 156
155- *ptest:* Enables building the package tests where supported by 157- *ptest:* Enables building the package tests where supported by
156 individual recipes. For more information on package tests, see the 158 individual recipes. For more information on package tests, see the
157 "`Testing Packages With 159 ":ref:`dev-manual/dev-manual-common-tasks:testing packages with ptest`" section
158 ptest <&YOCTO_DOCS_DEV_URL;#testing-packages-with-ptest>`__" section
159 in the Yocto Project Development Tasks Manual. 160 in the Yocto Project Development Tasks Manual.
160 161
161- *smbfs:* Include SMB networks client support (for mounting 162- *smbfs:* Include SMB networks client support (for mounting
@@ -237,8 +238,8 @@ The following image features are available for all images:
237- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes. 238- *ptest-pkgs:* Installs ptest packages for all ptest-enabled recipes.
238 239
239- *read-only-rootfs:* Creates an image whose root filesystem is 240- *read-only-rootfs:* Creates an image whose root filesystem is
240 read-only. See the "`Creating a Read-Only Root 241 read-only. See the
241 Filesystem <&YOCTO_DOCS_DEV_URL;#creating-a-read-only-root-filesystem>`__" 242 ":ref:`dev-manual/dev-manual-common-tasks:creating a read-only root filesystem`"
242 section in the Yocto Project Development Tasks Manual for more 243 section in the Yocto Project Development Tasks Manual for more
243 information. 244 information.
244 245
@@ -263,8 +264,7 @@ these valid features is as follows:
263 264
264- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and 265- *perf:* Installs profiling tools such as ``perf``, ``systemtap``, and
265 ``LTTng``. For general information on user-space tools, see the 266 ``LTTng``. For general information on user-space tools, see the
266 `Yocto Project Application Development and the Extensible Software 267 :doc:`../sdk-manual/sdk-manual` manual.
267 Development Kit (eSDK) <&YOCTO_DOCS_SDK_URL;>`__ manual.
268 268
269- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server. 269- *ssh-server-dropbear:* Installs the Dropbear minimal SSH server.
270 270
@@ -275,12 +275,10 @@ these valid features is as follows:
275 will not be installed. 275 will not be installed.
276 276
277- *tools-debug:* Installs debugging tools such as ``strace`` and 277- *tools-debug:* Installs debugging tools such as ``strace`` and
278 ``gdb``. For information on GDB, see the "`Debugging With the GNU 278 ``gdb``. For information on GDB, see the
279 Project Debugger (GDB) 279 ":ref:`platdev-gdb-remotedebug`" section
280 Remotely <&YOCTO_DOCS_DEV_URL;#platdev-gdb-remotedebug>`__" section
281 in the Yocto Project Development Tasks Manual. For information on 280 in the Yocto Project Development Tasks Manual. For information on
282 tracing and profiling, see the `Yocto Project Profiling and Tracing 281 tracing and profiling, see the :doc:`../profile-manual/profile-manual`.
283 Manual <&YOCTO_DOCS_PROF_URL;>`__.
284 282
285- *tools-sdk:* Installs a full SDK that runs on the device. 283- *tools-sdk:* Installs a full SDK that runs on the device.
286 284