diff options
| author | Scott Rifenbark <srifenbark@gmail.com> | 2016-09-26 08:35:56 -0700 |
|---|---|---|
| committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2016-09-28 15:02:33 +0100 |
| commit | 2199b68fc88cd7f34fda7ad49bd50ca5176e0f5b (patch) | |
| tree | ac53c00270a7e68c7f5a870521722f3591a7970c /documentation | |
| parent | 99b9efb9930b37863ceee073a479ea62e4c4ff73 (diff) | |
| download | poky-2199b68fc88cd7f34fda7ad49bd50ca5176e0f5b.tar.gz | |
dev-manual: Updated the devpyshell section
Fixes [YOCTO #9166]
I applied some review comments to the section. Pulled some stuff
out that did not apply.pdated the devpyshell section
(From yocto-docs rev: 7300358570de4da94ff5f22afd30128ef8dd0f13)
Signed-off-by: Scott Rifenbark <srifenbark@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation')
| -rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 89 |
1 files changed, 4 insertions, 85 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 6f359c2986..1008e11696 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
| @@ -1606,12 +1606,7 @@ | |||
| 1606 | including | 1606 | including |
| 1607 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> | 1607 | <ulink url='&YOCTO_DOCS_REF_URL;#ref-tasks-patch'><filename>do_patch</filename></ulink> |
| 1608 | are run for the specified target. | 1608 | are run for the specified target. |
| 1609 | Then, a new terminal is opened and you are placed in | 1609 | Then a new terminal is opened. |
| 1610 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink><filename>}</filename>, | ||
| 1611 | the source directory. | ||
| 1612 | In the new terminal, all the OpenEmbedded build-related environment variables are | ||
| 1613 | still defined so you can use commands such as <filename>configure</filename> and | ||
| 1614 | <filename>make</filename>. | ||
| 1615 | Additionally, key Python objects and code are available in the same | 1610 | Additionally, key Python objects and code are available in the same |
| 1616 | way they are to BitBake tasks, in particular, the data store 'd'. | 1611 | way they are to BitBake tasks, in particular, the data store 'd'. |
| 1617 | So, commands such as the following are useful when exploring the data | 1612 | So, commands such as the following are useful when exploring the data |
| @@ -1650,86 +1645,10 @@ | |||
| 1650 | </para> | 1645 | </para> |
| 1651 | 1646 | ||
| 1652 | <para> | 1647 | <para> |
| 1653 | For spawned terminals, the following occurs: | 1648 | When you are finished using <filename>devpyshell</filename>, you |
| 1654 | <itemizedlist> | 1649 | can exit the shell either by using Ctrl+d or closing the terminal |
| 1655 | <listitem><para>The <filename>PATH</filename> variable includes the | 1650 | window. |
| 1656 | cross-toolchain.</para></listitem> | ||
| 1657 | <listitem><para>The <filename>pkgconfig</filename> variables find the correct | ||
| 1658 | <filename>.pc</filename> files.</para></listitem> | ||
| 1659 | <listitem><para>The <filename>configure</filename> command finds the | ||
| 1660 | Yocto Project site files as well as any other necessary files.</para></listitem> | ||
| 1661 | </itemizedlist> | ||
| 1662 | </para> | ||
| 1663 | |||
| 1664 | <para> | ||
| 1665 | Within this environment, you can run configure or compile | ||
| 1666 | commands as if they were being run by | ||
| 1667 | the OpenEmbedded build system itself. | ||
| 1668 | As noted earlier, the working directory also automatically changes to the | ||
| 1669 | Source Directory (<ulink url='&YOCTO_DOCS_REF_URL;#var-S'><filename>S</filename></ulink>). | ||
| 1670 | </para> | ||
| 1671 | |||
| 1672 | <para> | ||
| 1673 | To manually run a specific task using <filename>devpyshell</filename>, | ||
| 1674 | run the corresponding <filename>run.*</filename> script in | ||
| 1675 | the | ||
| 1676 | <filename>${</filename><ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink><filename>}/temp</filename> | ||
| 1677 | directory (e.g., | ||
| 1678 | <filename>run.do_configure.</filename><replaceable>pid</replaceable>). | ||
| 1679 | If a task's script does not exist, which would be the case if the task was | ||
| 1680 | skipped by way of the sstate cache, you can create the task by first running | ||
| 1681 | it outside of the <filename>devshell</filename>: | ||
| 1682 | <literallayout class='monospaced'> | ||
| 1683 | $ bitbake -c <replaceable>task</replaceable> | ||
| 1684 | </literallayout> | ||
| 1685 | <note><title>Notes</title> | ||
| 1686 | <itemizedlist> | ||
| 1687 | <listitem><para>Execution of a task's <filename>run.*</filename> | ||
| 1688 | script and BitBake's execution of a task are identical. | ||
| 1689 | In other words, running the script re-runs the task | ||
| 1690 | just as it would be run using the | ||
| 1691 | <filename>bitbake -c</filename> command. | ||
| 1692 | </para></listitem> | ||
| 1693 | <listitem><para>Any <filename>run.*</filename> file that does not | ||
| 1694 | have a <filename>.pid</filename> extension is a | ||
| 1695 | symbolic link (symlink) to the most recent version of that | ||
| 1696 | file. | ||
| 1697 | </para></listitem> | ||
| 1698 | </itemizedlist> | ||
| 1699 | </note> | ||
| 1700 | </para> | ||
| 1701 | |||
| 1702 | <para> | ||
| 1703 | Remember, that the <filename>devpyshell</filename> is a mechanism that allows | ||
| 1704 | you to get into the BitBake task execution environment | ||
| 1705 | through an interactive Python interpreter. | ||
| 1706 | And as such, all commands must be called just as BitBake would call them. | ||
| 1707 | That means you need to provide the appropriate options for | ||
| 1708 | cross-compilation and so forth as applicable. | ||
| 1709 | </para> | 1651 | </para> |
| 1710 | |||
| 1711 | <para> | ||
| 1712 | When you are finished using <filename>devpyshell</filename>, exit the shell | ||
| 1713 | or close the terminal window. | ||
| 1714 | </para> | ||
| 1715 | |||
| 1716 | <note><title>Notes</title> | ||
| 1717 | <itemizedlist> | ||
| 1718 | <listitem><para> | ||
| 1719 | It is worth remembering that when using <filename>devpyshell</filename> | ||
| 1720 | you need to use the full compiler name such as <filename>arm-poky-linux-gnueabi-gcc</filename> | ||
| 1721 | instead of just using <filename>gcc</filename>. | ||
| 1722 | The same applies to other applications such as <filename>binutils</filename>, | ||
| 1723 | <filename>libtool</filename> and so forth. | ||
| 1724 | BitBake sets up environment variables such as <filename>CC</filename> | ||
| 1725 | to assist applications, such as <filename>make</filename> to find the correct tools. | ||
| 1726 | </para></listitem> | ||
| 1727 | <listitem><para> | ||
| 1728 | It is also worth noting that <filename>devpyshell</filename> still works over | ||
| 1729 | X11 forwarding and similar situations. | ||
| 1730 | </para></listitem> | ||
| 1731 | </itemizedlist> | ||
| 1732 | </note> | ||
| 1733 | </section> | 1652 | </section> |
| 1734 | 1653 | ||
| 1735 | </chapter> | 1654 | </chapter> |
