diff options
author | Michael Opdenacker <michael.opdenacker@bootlin.com> | 2021-04-16 18:27:05 +0200 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-04-23 16:39:03 +0100 |
commit | c3c6de21876aad811e08538544c8fe76d22ccd09 (patch) | |
tree | e22ee00a9c1ec588965f32050a42e05946bc9f71 /documentation/sdk-manual/appendix-customizing.rst | |
parent | 773536c333248214f8f41eff698d8bfd3c687249 (diff) | |
download | poky-c3c6de21876aad811e08538544c8fe76d22ccd09.tar.gz |
manuals: code insertion simplification over two lines
This simplifies paragraphs ending with a colon and followed
by code insertion.
Automatically substituted through the command:
sed -i -z "s/:\n\s*::/::/g" file.rst
This generates identical HTML output.
(From yocto-docs rev: 28e2192a7c12d64b68061138a9f6c796453eebb1)
Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/sdk-manual/appendix-customizing.rst')
-rw-r--r-- | documentation/sdk-manual/appendix-customizing.rst | 27 |
1 files changed, 9 insertions, 18 deletions
diff --git a/documentation/sdk-manual/appendix-customizing.rst b/documentation/sdk-manual/appendix-customizing.rst index 8e7115046b..fb2d78452b 100644 --- a/documentation/sdk-manual/appendix-customizing.rst +++ b/documentation/sdk-manual/appendix-customizing.rst | |||
@@ -149,8 +149,7 @@ from the :term:`DISTRO` variable. | |||
149 | The | 149 | The |
150 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` | 150 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
151 | class defines the default value of the ``SDK_TITLE`` variable as | 151 | class defines the default value of the ``SDK_TITLE`` variable as |
152 | follows: | 152 | follows:: |
153 | :: | ||
154 | 153 | ||
155 | SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" | 154 | SDK_TITLE ??= "${@d.getVar('DISTRO_NAME') or d.getVar('DISTRO')} SDK" |
156 | 155 | ||
@@ -162,8 +161,7 @@ an example, assume you have your own layer for your distribution named | |||
162 | does the default "poky" distribution. If so, you could update the | 161 | does the default "poky" distribution. If so, you could update the |
163 | ``SDK_TITLE`` variable in the | 162 | ``SDK_TITLE`` variable in the |
164 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following | 163 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following |
165 | form: | 164 | form:: |
166 | :: | ||
167 | 165 | ||
168 | SDK_TITLE = "your_title" | 166 | SDK_TITLE = "your_title" |
169 | 167 | ||
@@ -194,8 +192,7 @@ the installed SDKs to update the installed SDKs by using the | |||
194 | 3. Build the extensible SDK normally (i.e., use the | 192 | 3. Build the extensible SDK normally (i.e., use the |
195 | ``bitbake -c populate_sdk_ext`` imagename command). | 193 | ``bitbake -c populate_sdk_ext`` imagename command). |
196 | 194 | ||
197 | 4. Publish the SDK using the following command: | 195 | 4. Publish the SDK using the following command:: |
198 | :: | ||
199 | 196 | ||
200 | $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory | 197 | $ oe-publish-sdk some_path/sdk-installer.sh path_to_shared_http_directory |
201 | 198 | ||
@@ -218,8 +215,7 @@ installation directory for the SDK is based on the | |||
218 | :term:`SDKEXTPATH` variables from | 215 | :term:`SDKEXTPATH` variables from |
219 | within the | 216 | within the |
220 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` | 217 | :ref:`populate_sdk_base <ref-classes-populate-sdk-*>` |
221 | class as follows: | 218 | class as follows:: |
222 | :: | ||
223 | 219 | ||
224 | SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" | 220 | SDKEXTPATH ??= "~/${@d.getVar('DISTRO')}_sdk" |
225 | 221 | ||
@@ -236,8 +232,7 @@ assume you have your own layer for your distribution named | |||
236 | does the default "poky" distribution. If so, you could update the | 232 | does the default "poky" distribution. If so, you could update the |
237 | ``SDKEXTPATH`` variable in the | 233 | ``SDKEXTPATH`` variable in the |
238 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following | 234 | ``~/meta-mydistro/conf/distro/mydistro.conf`` file using the following |
239 | form: | 235 | form:: |
240 | :: | ||
241 | 236 | ||
242 | SDKEXTPATH = "some_path_for_your_installed_sdk" | 237 | SDKEXTPATH = "some_path_for_your_installed_sdk" |
243 | 238 | ||
@@ -272,8 +267,7 @@ source, you need to do a number of things: | |||
272 | 267 | ||
273 | 3. Set the appropriate configuration so that the produced SDK knows how | 268 | 3. Set the appropriate configuration so that the produced SDK knows how |
274 | to find the configuration. The variable you need to set is | 269 | to find the configuration. The variable you need to set is |
275 | :term:`SSTATE_MIRRORS`: | 270 | :term:`SSTATE_MIRRORS`:: |
276 | :: | ||
277 | 271 | ||
278 | SSTATE_MIRRORS = "file://.* http://example.com/some_path/sstate-cache/PATH" | 272 | SSTATE_MIRRORS = "file://.* http://example.com/some_path/sstate-cache/PATH" |
279 | 273 | ||
@@ -287,8 +281,7 @@ source, you need to do a number of things: | |||
287 | side, and its contents will not interfere with the build), then | 281 | side, and its contents will not interfere with the build), then |
288 | you can set the variable in your ``local.conf`` or custom distro | 282 | you can set the variable in your ``local.conf`` or custom distro |
289 | configuration file. You can then "whitelist" the variable through | 283 | configuration file. You can then "whitelist" the variable through |
290 | to the SDK by adding the following: | 284 | to the SDK by adding the following:: |
291 | :: | ||
292 | 285 | ||
293 | SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" | 286 | SDK_LOCAL_CONF_WHITELIST = "SSTATE_MIRRORS" |
294 | 287 | ||
@@ -313,8 +306,7 @@ everything needed to reconstruct the image for which the SDK was built. | |||
313 | This bundling can lead to an SDK installer file that is a Gigabyte or | 306 | This bundling can lead to an SDK installer file that is a Gigabyte or |
314 | more in size. If the size of this file causes a problem, you can build | 307 | more in size. If the size of this file causes a problem, you can build |
315 | an SDK that has just enough in it to install and provide access to the | 308 | an SDK that has just enough in it to install and provide access to the |
316 | ``devtool command`` by setting the following in your configuration: | 309 | ``devtool command`` by setting the following in your configuration:: |
317 | :: | ||
318 | 310 | ||
319 | SDK_EXT_TYPE = "minimal" | 311 | SDK_EXT_TYPE = "minimal" |
320 | 312 | ||
@@ -336,8 +328,7 @@ information enables the ``devtool search`` command to return useful | |||
336 | results. | 328 | results. |
337 | 329 | ||
338 | To facilitate this wider range of information, you would need to set the | 330 | To facilitate this wider range of information, you would need to set the |
339 | following: | 331 | following:: |
340 | :: | ||
341 | 332 | ||
342 | SDK_INCLUDE_PKGDATA = "1" | 333 | SDK_INCLUDE_PKGDATA = "1" |
343 | 334 | ||