summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Opdenacker <michael.opdenacker@bootlin.com>2021-10-18 15:05:33 (GMT)
committerRichard Purdie <richard.purdie@linuxfoundation.org>2021-10-20 19:22:20 (GMT)
commit07108739ce3283576e2041d6b399c9a21b579f6d (patch)
tree9023dd8c6fa5a2d1e3e4d3cce7b3f77feeaae72f
parent5550d83ff7a9a2ad213bad7ba06c3b77835e815d (diff)
downloadpoky-07108739ce3283576e2041d6b399c9a21b579f6d.tar.gz
manuals: rename "devpyshell" to "pydevshell"
This addresses [YOCTO #14531] after the "devpyshell" task was renamed to "pydevshell" in OE core. (From yocto-docs rev: 1056320e90545c8dff0fc71a5fde752295d4d6e4) Signed-off-by: Michael Opdenacker <michael.opdenacker@bootlin.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/common-tasks.rst12
-rw-r--r--documentation/ref-manual/tasks.rst8
2 files changed, 10 insertions, 10 deletions
diff --git a/documentation/dev-manual/common-tasks.rst b/documentation/dev-manual/common-tasks.rst
index 4683b1c..3eead14 100644
--- a/documentation/dev-manual/common-tasks.rst
+++ b/documentation/dev-manual/common-tasks.rst
@@ -3531,14 +3531,14 @@ terminal window.
3531 - It is also worth noting that ``devshell`` still works over X11 3531 - It is also worth noting that ``devshell`` still works over X11
3532 forwarding and similar situations. 3532 forwarding and similar situations.
3533 3533
3534Using a Development Python Shell 3534Using a Python Development Shell
3535================================ 3535================================
3536 3536
3537Similar to working within a development shell as described in the 3537Similar to working within a development shell as described in the
3538previous section, you can also spawn and work within an interactive 3538previous section, you can also spawn and work within an interactive
3539Python development shell. When debugging certain commands or even when 3539Python development shell. When debugging certain commands or even when
3540just editing packages, ``devpyshell`` can be a useful tool. When you 3540just editing packages, ``pydevshell`` can be a useful tool. When you
3541invoke the ``devpyshell`` task, all tasks up to and including 3541invoke the ``pydevshell`` task, all tasks up to and including
3542:ref:`ref-tasks-patch` are run for the 3542:ref:`ref-tasks-patch` are run for the
3543specified target. Then a new terminal is opened. Additionally, key 3543specified target. Then a new terminal is opened. Additionally, key
3544Python objects and code are available in the same way they are to 3544Python objects and code are available in the same way they are to
@@ -3563,17 +3563,17 @@ system were executing them. Consequently, working this way can be
3563helpful when debugging a build or preparing software to be used with the 3563helpful when debugging a build or preparing software to be used with the
3564OpenEmbedded build system. 3564OpenEmbedded build system.
3565 3565
3566Following is an example that uses ``devpyshell`` on a target named 3566Following is an example that uses ``pydevshell`` on a target named
3567``matchbox-desktop``:: 3567``matchbox-desktop``::
3568 3568
3569 $ bitbake matchbox-desktop -c devpyshell 3569 $ bitbake matchbox-desktop -c pydevshell
3570 3570
3571This command spawns a terminal and places you in an interactive Python 3571This command spawns a terminal and places you in an interactive Python
3572interpreter within the OpenEmbedded build environment. The 3572interpreter within the OpenEmbedded build environment. The
3573:term:`OE_TERMINAL` variable 3573:term:`OE_TERMINAL` variable
3574controls what type of shell is opened. 3574controls what type of shell is opened.
3575 3575
3576When you are finished using ``devpyshell``, you can exit the shell 3576When you are finished using ``pydevshell``, you can exit the shell
3577either by using Ctrl+d or closing the terminal window. 3577either by using Ctrl+d or closing the terminal window.
3578 3578
3579Building 3579Building
diff --git a/documentation/ref-manual/tasks.rst b/documentation/ref-manual/tasks.rst
index 4edae33..299969d 100644
--- a/documentation/ref-manual/tasks.rst
+++ b/documentation/ref-manual/tasks.rst
@@ -516,17 +516,17 @@ scratch is guaranteed.
516 $ bitbake -f -c do_cleansstate target 516 $ bitbake -f -c do_cleansstate target
517 517
518 518
519.. _ref-tasks-devpyshell: 519.. _ref-tasks-pydevshell:
520 520
521``do_devpyshell`` 521``do_pydevshell``
522----------------- 522-----------------
523 523
524Starts a shell in which an interactive Python interpreter allows you to 524Starts a shell in which an interactive Python interpreter allows you to
525interact with the BitBake build environment. From within this shell, you 525interact with the BitBake build environment. From within this shell, you
526can directly examine and set bits from the data store and execute 526can directly examine and set bits from the data store and execute
527functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a development python shell`" section in 527functions as if within the BitBake environment. See the ":ref:`dev-manual/common-tasks:using a python development shell`" section in
528the Yocto Project Development Tasks Manual for more information about 528the Yocto Project Development Tasks Manual for more information about
529using ``devpyshell``. 529using ``pydevshell``.
530 530
531.. _ref-tasks-devshell: 531.. _ref-tasks-devshell:
532 532