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/ref-manual/structure.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/ref-manual/structure.rst')
| -rw-r--r-- | documentation/ref-manual/structure.rst | 18 |
1 files changed, 6 insertions, 12 deletions
diff --git a/documentation/ref-manual/structure.rst b/documentation/ref-manual/structure.rst index 0f2093a8d4..f8dc7d2821 100644 --- a/documentation/ref-manual/structure.rst +++ b/documentation/ref-manual/structure.rst | |||
| @@ -153,8 +153,7 @@ When you run this script, your Yocto Project environment is set up, a | |||
| 153 | :term:`Build Directory` is created, your working | 153 | :term:`Build Directory` is created, your working |
| 154 | directory becomes the Build Directory, and you are presented with some | 154 | directory becomes the Build Directory, and you are presented with some |
| 155 | simple suggestions as to what to do next, including a list of some | 155 | simple suggestions as to what to do next, including a list of some |
| 156 | possible targets to build. Here is an example: | 156 | possible targets to build. Here is an example:: |
| 157 | :: | ||
| 158 | 157 | ||
| 159 | $ source oe-init-build-env | 158 | $ source oe-init-build-env |
| 160 | 159 | ||
| @@ -185,8 +184,7 @@ creates the ``build/`` directory in your current working directory. If | |||
| 185 | you provide a Build Directory argument when you ``source`` the script, | 184 | you provide a Build Directory argument when you ``source`` the script, |
| 186 | you direct the OpenEmbedded build system to create a Build Directory of | 185 | you direct the OpenEmbedded build system to create a Build Directory of |
| 187 | your choice. For example, the following command creates a Build | 186 | your choice. For example, the following command creates a Build |
| 188 | Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`: | 187 | Directory named ``mybuilds/`` that is outside of the :term:`Source Directory`:: |
| 189 | :: | ||
| 190 | 188 | ||
| 191 | $ source oe-init-build-env ~/mybuilds | 189 | $ source oe-init-build-env ~/mybuilds |
| 192 | 190 | ||
| @@ -269,8 +267,7 @@ and to ``meta/conf/`` when you are building from the OpenEmbedded-Core | |||
| 269 | environment. Because the script variable points to the source of the | 267 | environment. Because the script variable points to the source of the |
| 270 | ``local.conf.sample`` file, this implies that you can configure your | 268 | ``local.conf.sample`` file, this implies that you can configure your |
| 271 | build environment from any layer by setting the variable in the | 269 | build environment from any layer by setting the variable in the |
| 272 | top-level build environment setup script as follows: | 270 | top-level build environment setup script as follows:: |
| 273 | :: | ||
| 274 | 271 | ||
| 275 | TEMPLATECONF=your_layer/conf | 272 | TEMPLATECONF=your_layer/conf |
| 276 | 273 | ||
| @@ -309,8 +306,7 @@ Project development environment, and to ``meta/conf/`` when you are | |||
| 309 | building from the OpenEmbedded-Core environment. Because the script | 306 | building from the OpenEmbedded-Core environment. Because the script |
| 310 | variable points to the source of the ``bblayers.conf.sample`` file, this | 307 | variable points to the source of the ``bblayers.conf.sample`` file, this |
| 311 | implies that you can base your build from any layer by setting the | 308 | implies that you can base your build from any layer by setting the |
| 312 | variable in the top-level build environment setup script as follows: | 309 | variable in the top-level build environment setup script as follows:: |
| 313 | :: | ||
| 314 | 310 | ||
| 315 | TEMPLATECONF=your_layer/conf | 311 | TEMPLATECONF=your_layer/conf |
| 316 | 312 | ||
| @@ -463,8 +459,7 @@ image again. | |||
| 463 | If you do accidentally delete files here, you will need to force them to | 459 | If you do accidentally delete files here, you will need to force them to |
| 464 | be re-created. In order to do that, you will need to know the target | 460 | be re-created. In order to do that, you will need to know the target |
| 465 | that produced them. For example, these commands rebuild and re-create | 461 | that produced them. For example, these commands rebuild and re-create |
| 466 | the kernel files: | 462 | the kernel files:: |
| 467 | :: | ||
| 468 | 463 | ||
| 469 | $ bitbake -c clean virtual/kernel | 464 | $ bitbake -c clean virtual/kernel |
| 470 | $ bitbake virtual/kernel | 465 | $ bitbake virtual/kernel |
| @@ -535,8 +530,7 @@ recipe-specific :term:`WORKDIR` directories. Thus, the | |||
| 535 | This directory holds information that BitBake uses for accounting | 530 | This directory holds information that BitBake uses for accounting |
| 536 | purposes to track what tasks have run and when they have run. The | 531 | purposes to track what tasks have run and when they have run. The |
| 537 | directory is sub-divided by architecture, package name, and version. | 532 | directory is sub-divided by architecture, package name, and version. |
| 538 | Following is an example: | 533 | Following is an example:: |
| 539 | :: | ||
| 540 | 534 | ||
| 541 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do | 535 | stamps/all-poky-linux/distcc-config/1.0-r0.do_build-2fdd....2do |
| 542 | 536 | ||
