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/devtool-reference.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/devtool-reference.rst')
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 51 |
1 files changed, 17 insertions, 34 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 629aa2ffb9..0ce3219831 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -22,8 +22,7 @@ Getting Help | |||
| 22 | 22 | ||
| 23 | The ``devtool`` command line is organized similarly to Git in that it | 23 | The ``devtool`` command line is organized similarly to Git in that it |
| 24 | has a number of sub-commands for each function. You can run | 24 | has a number of sub-commands for each function. You can run |
| 25 | ``devtool --help`` to see all the commands: | 25 | ``devtool --help`` to see all the commands:: |
| 26 | :: | ||
| 27 | 26 | ||
| 28 | $ devtool -h | 27 | $ devtool -h |
| 29 | NOTE: Starting bitbake server... | 28 | NOTE: Starting bitbake server... |
| @@ -79,8 +78,7 @@ has a number of sub-commands for each function. You can run | |||
| 79 | 78 | ||
| 80 | As directed in the general help output, you can | 79 | As directed in the general help output, you can |
| 81 | get more syntax on a specific command by providing the command name and | 80 | get more syntax on a specific command by providing the command name and |
| 82 | using "--help": | 81 | using "--help":: |
| 83 | :: | ||
| 84 | 82 | ||
| 85 | $ devtool add --help | 83 | $ devtool add --help |
| 86 | NOTE: Starting bitbake server... | 84 | NOTE: Starting bitbake server... |
| @@ -172,8 +170,7 @@ you. The source files the recipe uses should exist in an external area. | |||
| 172 | 170 | ||
| 173 | The following example creates and adds a new recipe named ``jackson`` to | 171 | The following example creates and adds a new recipe named ``jackson`` to |
| 174 | a workspace layer the tool creates. The source code built by the recipes | 172 | a workspace layer the tool creates. The source code built by the recipes |
| 175 | resides in ``/home/user/sources/jackson``: | 173 | resides in ``/home/user/sources/jackson``:: |
| 176 | :: | ||
| 177 | 174 | ||
| 178 | $ devtool add jackson /home/user/sources/jackson | 175 | $ devtool add jackson /home/user/sources/jackson |
| 179 | 176 | ||
| @@ -201,8 +198,7 @@ unpacking files from a remote URI. In some cases, you might want to | |||
| 201 | specify a source revision by branch, tag, or commit hash. You can | 198 | specify a source revision by branch, tag, or commit hash. You can |
| 202 | specify these options when using the ``devtool add`` command: | 199 | specify these options when using the ``devtool add`` command: |
| 203 | 200 | ||
| 204 | - To specify a source branch, use the ``--srcbranch`` option: | 201 | - To specify a source branch, use the ``--srcbranch`` option:: |
| 205 | :: | ||
| 206 | 202 | ||
| 207 | $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson | 203 | $ devtool add --srcbranch &DISTRO_NAME_NO_CAP; jackson /home/user/sources/jackson |
| 208 | 204 | ||
| @@ -210,8 +206,7 @@ specify these options when using the ``devtool add`` command: | |||
| 210 | branch. | 206 | branch. |
| 211 | 207 | ||
| 212 | - To specify a specific tag or commit hash, use the ``--srcrev`` | 208 | - To specify a specific tag or commit hash, use the ``--srcrev`` |
| 213 | option: | 209 | option:: |
| 214 | :: | ||
| 215 | 210 | ||
| 216 | $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson | 211 | $ devtool add --srcrev &DISTRO_REL_TAG; jackson /home/user/sources/jackson |
| 217 | $ devtool add --srcrev some_commit_hash /home/user/sources/jackson | 212 | $ devtool add --srcrev some_commit_hash /home/user/sources/jackson |
| @@ -269,8 +264,7 @@ The ``devtool modify`` command extracts the source for a recipe, sets it | |||
| 269 | up as a Git repository if the source had not already been fetched from | 264 | up as a Git repository if the source had not already been fetched from |
| 270 | Git, checks out a branch for development, and applies any patches from | 265 | Git, checks out a branch for development, and applies any patches from |
| 271 | the recipe as commits on top. You can use the following command to | 266 | the recipe as commits on top. You can use the following command to |
| 272 | checkout the source files: | 267 | checkout the source files:: |
| 273 | :: | ||
| 274 | 268 | ||
| 275 | $ devtool modify recipe | 269 | $ devtool modify recipe |
| 276 | 270 | ||
| @@ -309,8 +303,7 @@ compile, and test the code. | |||
| 309 | 303 | ||
| 310 | When you are satisfied with the results and you have committed your | 304 | When you are satisfied with the results and you have committed your |
| 311 | changes to the Git repository, you can then run the | 305 | changes to the Git repository, you can then run the |
| 312 | ``devtool update-recipe`` to create the patches and update the recipe: | 306 | ``devtool update-recipe`` to create the patches and update the recipe:: |
| 313 | :: | ||
| 314 | 307 | ||
| 315 | $ devtool update-recipe recipe | 308 | $ devtool update-recipe recipe |
| 316 | 309 | ||
| @@ -321,8 +314,7 @@ Often, you might want to apply customizations made to your software in | |||
| 321 | your own layer rather than apply them to the original recipe. If so, you | 314 | your own layer rather than apply them to the original recipe. If so, you |
| 322 | can use the ``-a`` or ``--append`` option with the | 315 | can use the ``-a`` or ``--append`` option with the |
| 323 | ``devtool update-recipe`` command. These options allow you to specify | 316 | ``devtool update-recipe`` command. These options allow you to specify |
| 324 | the layer into which to write an append file: | 317 | the layer into which to write an append file:: |
| 325 | :: | ||
| 326 | 318 | ||
| 327 | $ devtool update-recipe recipe -a base-layer-directory | 319 | $ devtool update-recipe recipe -a base-layer-directory |
| 328 | 320 | ||
| @@ -358,8 +350,7 @@ particular recipe. | |||
| 358 | recipe's latest version tag. | 350 | recipe's latest version tag. |
| 359 | 351 | ||
| 360 | As with all ``devtool`` commands, you can get help on the individual | 352 | As with all ``devtool`` commands, you can get help on the individual |
| 361 | command: | 353 | command:: |
| 362 | :: | ||
| 363 | 354 | ||
| 364 | $ devtool check-upgrade-status -h | 355 | $ devtool check-upgrade-status -h |
| 365 | NOTE: Starting bitbake server... | 356 | NOTE: Starting bitbake server... |
| @@ -462,8 +453,7 @@ files have been modified, the command preserves the modified files in a | |||
| 462 | separate "attic" subdirectory under the workspace layer. | 453 | separate "attic" subdirectory under the workspace layer. |
| 463 | 454 | ||
| 464 | Here is an example that resets the workspace directory that contains the | 455 | Here is an example that resets the workspace directory that contains the |
| 465 | ``mtr`` recipe: | 456 | ``mtr`` recipe:: |
| 466 | :: | ||
| 467 | 457 | ||
| 468 | $ devtool reset mtr | 458 | $ devtool reset mtr |
| 469 | NOTE: Cleaning sysroot for recipe mtr... | 459 | NOTE: Cleaning sysroot for recipe mtr... |
| @@ -482,8 +472,7 @@ Use the ``devtool build`` command to build your recipe. The | |||
| 482 | When you use the ``devtool build`` command, you must supply the root | 472 | When you use the ``devtool build`` command, you must supply the root |
| 483 | name of the recipe (i.e. do not provide versions, paths, or extensions). | 473 | name of the recipe (i.e. do not provide versions, paths, or extensions). |
| 484 | You can use either the "-s" or the "--disable-parallel-make" options to | 474 | You can use either the "-s" or the "--disable-parallel-make" options to |
| 485 | disable parallel makes during the build. Here is an example: | 475 | disable parallel makes during the build. Here is an example:: |
| 486 | :: | ||
| 487 | 476 | ||
| 488 | $ devtool build recipe | 477 | $ devtool build recipe |
| 489 | 478 | ||
| @@ -499,8 +488,7 @@ device for testing. For proper integration into a final image, you need | |||
| 499 | to edit your custom image recipe appropriately. | 488 | to edit your custom image recipe appropriately. |
| 500 | 489 | ||
| 501 | When you use the ``devtool build-image`` command, you must supply the | 490 | When you use the ``devtool build-image`` command, you must supply the |
| 502 | name of the image. This command has no command line options: | 491 | name of the image. This command has no command line options:: |
| 503 | :: | ||
| 504 | 492 | ||
| 505 | $ devtool build-image image | 493 | $ devtool build-image image |
| 506 | 494 | ||
| @@ -510,8 +498,7 @@ Deploying Your Software on the Target Machine | |||
| 510 | ============================================= | 498 | ============================================= |
| 511 | 499 | ||
| 512 | Use the ``devtool deploy-target`` command to deploy the recipe's build | 500 | Use the ``devtool deploy-target`` command to deploy the recipe's build |
| 513 | output to the live target machine: | 501 | output to the live target machine:: |
| 514 | :: | ||
| 515 | 502 | ||
| 516 | $ devtool deploy-target recipe target | 503 | $ devtool deploy-target recipe target |
| 517 | 504 | ||
| @@ -582,15 +569,13 @@ new workspace layer, it is populated with the ``README`` file and the | |||
| 582 | ``conf`` directory only. | 569 | ``conf`` directory only. |
| 583 | 570 | ||
| 584 | The following example creates a new workspace layer in your current | 571 | The following example creates a new workspace layer in your current |
| 585 | working and by default names the workspace layer "workspace": | 572 | working and by default names the workspace layer "workspace":: |
| 586 | :: | ||
| 587 | 573 | ||
| 588 | $ devtool create-workspace | 574 | $ devtool create-workspace |
| 589 | 575 | ||
| 590 | You can create a workspace layer anywhere by supplying a pathname with | 576 | You can create a workspace layer anywhere by supplying a pathname with |
| 591 | the command. The following command creates a new workspace layer named | 577 | the command. The following command creates a new workspace layer named |
| 592 | "new-workspace": | 578 | "new-workspace":: |
| 593 | :: | ||
| 594 | 579 | ||
| 595 | $ devtool create-workspace /home/scottrif/new-workspace | 580 | $ devtool create-workspace /home/scottrif/new-workspace |
| 596 | 581 | ||
| @@ -603,15 +588,13 @@ Use the ``devtool status`` command to list the recipes currently in your | |||
| 603 | workspace. Information includes the paths to their respective external | 588 | workspace. Information includes the paths to their respective external |
| 604 | source trees. | 589 | source trees. |
| 605 | 590 | ||
| 606 | The ``devtool status`` command has no command-line options: | 591 | The ``devtool status`` command has no command-line options:: |
| 607 | :: | ||
| 608 | 592 | ||
| 609 | $ devtool status | 593 | $ devtool status |
| 610 | 594 | ||
| 611 | Following is sample output after using | 595 | Following is sample output after using |
| 612 | :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` | 596 | :ref:`devtool add <ref-manual/devtool-reference:adding a new recipe to the workspace layer>` |
| 613 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory: | 597 | to create and add the ``mtr_0.86.bb`` recipe to the ``workspace`` directory:: |
| 614 | :: | ||
| 615 | 598 | ||
| 616 | $ devtool status | 599 | $ devtool status |
| 617 | mtr:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) | 600 | mtr:/home/scottrif/poky/build/workspace/sources/mtr (/home/scottrif/poky/build/workspace/recipes/mtr/mtr_0.86.bb) |
