diff options
| -rw-r--r-- | documentation/ref-manual/devtool-reference.rst | 54 |
1 files changed, 54 insertions, 0 deletions
diff --git a/documentation/ref-manual/devtool-reference.rst b/documentation/ref-manual/devtool-reference.rst index 9c36195c5a..d74d5c29ae 100644 --- a/documentation/ref-manual/devtool-reference.rst +++ b/documentation/ref-manual/devtool-reference.rst | |||
| @@ -463,6 +463,20 @@ Here is an example that resets the workspace directory that contains the | |||
| 463 | NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually | 463 | NOTE: Leaving source tree /home/scottrif/poky/build/workspace/sources/mtr as-is; if you no longer need it then please delete it manually |
| 464 | $ | 464 | $ |
| 465 | 465 | ||
| 466 | .. _devtool-finish-working-on-a-recipe: | ||
| 467 | |||
| 468 | Finish Working on a Recipe | ||
| 469 | ========================== | ||
| 470 | |||
| 471 | Use the ``devtool finish`` command to push any committed changes to the | ||
| 472 | specified recipe in the specified layer and remove it from your workspace. | ||
| 473 | |||
| 474 | This is roughly equivalent to the ``devtool update-recipe`` command followed by | ||
| 475 | the ``devtool reset`` command. The changes must have been committed to the git | ||
| 476 | repository created by ``devtool``. Here is an example:: | ||
| 477 | |||
| 478 | $ devtool finish recipe /path/to/custom/layer | ||
| 479 | |||
| 466 | .. _devtool-building-your-recipe: | 480 | .. _devtool-building-your-recipe: |
| 467 | 481 | ||
| 468 | Building Your Recipe | 482 | Building Your Recipe |
| @@ -614,3 +628,43 @@ a match. | |||
| 614 | 628 | ||
| 615 | When you use the ``devtool search`` command, you must supply a keyword. | 629 | When you use the ``devtool search`` command, you must supply a keyword. |
| 616 | The command uses the keyword when searching for a match. | 630 | The command uses the keyword when searching for a match. |
| 631 | |||
| 632 | Alternatively, the ``devtool find-recipe`` command can be used to search for | ||
| 633 | recipe files instead of recipe names. Likewise, you must supply a keyword. | ||
| 634 | |||
| 635 | .. _devtool-get-the-configure-script-help: | ||
| 636 | |||
| 637 | Get Information on Recipe Configuration Scripts | ||
| 638 | =============================================== | ||
| 639 | |||
| 640 | Use the ``devtool configure-help`` command to get help on the configuration | ||
| 641 | script options for a given recipe. You must supply the recipe name to the | ||
| 642 | command. For example, it shows the output of ``./configure --help`` for | ||
| 643 | :ref:`autotools <ref-classes-autotools>`-based recipes. | ||
| 644 | |||
| 645 | The ``configure-help`` command will also display the configuration options | ||
| 646 | currently in use, including the ones passed through the :term:`EXTRA_OECONF` | ||
| 647 | variable. | ||
| 648 | |||
| 649 | .. _devtool-generate-an-ide-configuration-for-a-recipe: | ||
| 650 | |||
| 651 | Generate an IDE Configuration for a Recipe | ||
| 652 | ========================================== | ||
| 653 | |||
| 654 | The ``devtool ide-sdk`` automatically creates an IDE configuration and SDK to | ||
| 655 | work on a given recipe. Depending on the ``--mode`` parameter, different types | ||
| 656 | of SDKs are generated: | ||
| 657 | |||
| 658 | - ``modified`` mode: this creates an SDK and generates an IDE configuration in | ||
| 659 | the workspace directory. | ||
| 660 | |||
| 661 | - ``shared`` mode: this creates a cross-compiling toolchain and the | ||
| 662 | corresponding shared sysroot directories of the supplied recipe(s). | ||
| 663 | |||
| 664 | The ``--target`` option can be used to specify a ``username@hostname`` string | ||
| 665 | and create a remote debugging configuration for the recipe. Similarly to | ||
| 666 | ``devtool deploy-target``, it requires an SSH server running on the target. | ||
| 667 | |||
| 668 | For further details on the ``devtool ide-sdk`` command, see the | ||
| 669 | ":doc:`/sdk-manual/extensible`" chapter in the Yocto Project Application | ||
| 670 | Development and the Extensible Software Development Kit (eSDK) manual. | ||
