diff options
author | Scott Rifenbark <scott.m.rifenbark@intel.com> | 2014-01-21 10:23:57 -0600 |
---|---|---|
committer | Richard Purdie <richard.purdie@linuxfoundation.org> | 2014-01-21 21:58:03 +0000 |
commit | 0fa214421a3031d5626756a1eac6a205848fd6d0 (patch) | |
tree | 98c8af66e6eda9d17cec6566e7689c20487824af /documentation/dev-manual/dev-manual-model.xml | |
parent | 76240de5518109c962d22e396192165a228145cc (diff) | |
download | poky-0fa214421a3031d5626756a1eac6a205848fd6d0.tar.gz |
dev-manual: Updated the section that describes finding source code.
I changed the description to match that which is used in the
WORKDIR variable.
(From yocto-docs rev: 7d9071c2bb99e7c3f3eeae9ddf0abc34563c6725)
Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
Diffstat (limited to 'documentation/dev-manual/dev-manual-model.xml')
-rw-r--r-- | documentation/dev-manual/dev-manual-model.xml | 74 |
1 files changed, 31 insertions, 43 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml index 8260e84d20..6e07c8d1d0 100644 --- a/documentation/dev-manual/dev-manual-model.xml +++ b/documentation/dev-manual/dev-manual-model.xml | |||
@@ -1662,58 +1662,46 @@ | |||
1662 | 1662 | ||
1663 | <para> | 1663 | <para> |
1664 | The path to the work directory for the recipe | 1664 | The path to the work directory for the recipe |
1665 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends | 1665 | (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) |
1666 | on the recipe name and the architecture of the target device. | 1666 | is defined as follows: |
1667 | For example, here is the work directory for recipes and resulting packages that are | ||
1668 | not device-dependent: | ||
1669 | <literallayout class='monospaced'> | 1667 | <literallayout class='monospaced'> |
1670 | ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}/${EXTENDPE}${PV}-${PR} | 1668 | ${TMPDIR}/work/${MULTIMACH_TARGET_SYS}/${PN}/${EXTENDPE}${PV}-${PR} |
1671 | </literallayout> | ||
1672 | Let's look at an example without variables. | ||
1673 | Assuming a top-level <link linkend='source-directory'>Source Directory</link> | ||
1674 | named <filename>poky</filename> | ||
1675 | and a default Build Directory of <filename>poky/build</filename>, | ||
1676 | the following is the work directory for the <filename>acl</filename> recipe that | ||
1677 | creates the <filename>acl</filename> package: | ||
1678 | <literallayout class='monospaced'> | ||
1679 | poky/build/tmp/work/i586-poky-linux/acl/2.2.51-r3/ | ||
1680 | </literallayout> | 1669 | </literallayout> |
1670 | The actual directory depends on several things: | ||
1671 | <itemizedlist> | ||
1672 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>: | ||
1673 | The top-level build output directory</listitem> | ||
1674 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></ulink>: | ||
1675 | The target system identifier</listitem> | ||
1676 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>: | ||
1677 | The recipe name</listitem> | ||
1678 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-EXTENDPE'><filename>EXTENDPE</filename></ulink>: | ||
1679 | The epoch - (if | ||
1680 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PE'><filename>PE</filename></ulink> | ||
1681 | is not specified, which is usually the case for most | ||
1682 | recipes, then <filename>EXTENDPE</filename> is blank)</listitem> | ||
1683 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>: | ||
1684 | The recipe version</listitem> | ||
1685 | <listitem><ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink>: | ||
1686 | The recipe revision</listitem> | ||
1687 | </itemizedlist> | ||
1681 | </para> | 1688 | </para> |
1682 | 1689 | ||
1683 | <para> | 1690 | <para> |
1684 | If your resulting package is dependent on the target device, | 1691 | As an example, assume a Source Directory top-level folder |
1685 | the work directory varies slightly: | 1692 | name <filename>poky</filename>, a default Build Directory at |
1686 | <literallayout class='monospaced'> | 1693 | <filename>poky/build</filename>, and a |
1687 | ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}/${EXTENDPE}${PV}-${PR} | 1694 | <filename>qemux86-poky-linux</filename> machine target |
1688 | </literallayout> | 1695 | system. |
1689 | Again, assuming top-level Source Directory named <filename>poky</filename> | 1696 | Furthermore, suppose your recipe is named |
1690 | and a default Build Directory of <filename>poky/build</filename>, the | 1697 | <filename>foo_1.3.0-r0.bb</filename>. |
1691 | following are the work and temporary source directories, respectively, | 1698 | In this case, the work directory the build system uses to |
1692 | for the <filename>acl</filename> package that is being | 1699 | build the package would be as follows: |
1693 | built for a MIPS-based device: | ||
1694 | <literallayout class='monospaced'> | 1700 | <literallayout class='monospaced'> |
1695 | poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2 | 1701 | poky/build/tmp/work/qemux86-poky-linux/foo/1.3.0-r0 |
1696 | poky/build/tmp/work/mips-poky-linux/acl/2.2.51-r2/acl-2.2.51 | ||
1697 | </literallayout> | 1702 | </literallayout> |
1698 | </para> | 1703 | </para> |
1699 | 1704 | ||
1700 | <note> | ||
1701 | To better understand how the OpenEmbedded build system resolves directories during the | ||
1702 | build process, see the glossary entries for the | ||
1703 | <ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>, | ||
1704 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>, | ||
1705 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TOPDIR'><filename>TOPDIR</filename></ulink>, | ||
1706 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PACKAGE_ARCH'><filename>PACKAGE_ARCH</filename></ulink>, | ||
1707 | <ulink url='&YOCTO_DOCS_REF_URL;#var-MULTIMACH_TARGET_SYS'><filename>MULTIMACH_TARGET_SYS</filename></ulink>, | ||
1708 | <ulink url='&YOCTO_DOCS_REF_URL;#var-TARGET_OS'><filename>TARGET_OS</filename></ulink>, | ||
1709 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PN'><filename>PN</filename></ulink>, | ||
1710 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PV'><filename>PV</filename></ulink>, | ||
1711 | <ulink url='&YOCTO_DOCS_REF_URL;#var-EXTENDPE'><filename>EXTENDPE</filename></ulink>, | ||
1712 | and | ||
1713 | <ulink url='&YOCTO_DOCS_REF_URL;#var-PR'><filename>PR</filename></ulink> | ||
1714 | variables in the Yocto Project Reference Manual. | ||
1715 | </note> | ||
1716 | |||
1717 | <para> | 1705 | <para> |
1718 | Now that you know where to locate the directory that has the temporary source code, | 1706 | Now that you know where to locate the directory that has the temporary source code, |
1719 | you can use a Quilt or Git workflow to make your edits, test the changes, | 1707 | you can use a Quilt or Git workflow to make your edits, test the changes, |