summaryrefslogtreecommitdiffstats
path: root/documentation/dev-manual
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2012-10-01 11:56:49 -0700
committerRichard Purdie <richard.purdie@linuxfoundation.org>2012-10-02 17:41:34 +0100
commit1628d3c4c5ad3e8155e973c9a7003f1f14a9087f (patch)
tree62492fcf52b6f2172bc42578480213015cd8a93f /documentation/dev-manual
parenta32c0b2babe5df0bc611d84cdcf6407544e61c9f (diff)
downloadpoky-1628d3c4c5ad3e8155e973c9a7003f1f14a9087f.tar.gz
documentation: dev-manual - Update to package/recipe wording
The example that describes changing the source code usees the P* variables extensively to refer to names of the recipes. The wording used was antiquated and exclusively referred to "Packages." I changed to reflect the fact that P* variables in general are refering the recipes and not the packages. (From yocto-docs rev: bd3ef1c46fc7a3b0b2ff5ab60dc52e125f080e24) 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')
-rw-r--r--documentation/dev-manual/dev-manual-model.xml22
1 files changed, 13 insertions, 9 deletions
diff --git a/documentation/dev-manual/dev-manual-model.xml b/documentation/dev-manual/dev-manual-model.xml
index 5035c95043..7ab9e015a6 100644
--- a/documentation/dev-manual/dev-manual-model.xml
+++ b/documentation/dev-manual/dev-manual-model.xml
@@ -1577,8 +1577,9 @@ directory.</para></listitem>
1577 For example, recipes that fetch their source from Git usually set 1577 For example, recipes that fetch their source from Git usually set
1578 <filename>S</filename> to <filename>${WORKDIR}/git</filename>. 1578 <filename>S</filename> to <filename>${WORKDIR}/git</filename>.
1579 <note> 1579 <note>
1580 <filename>BP</filename> represents the "Base Package", which is the base package 1580 The
1581 name and the package version: 1581 <ulink url='&YOCTO_DOCS_REF_URL;#var-BP'><filename>BP</filename></ulink>
1582 represents the base recipe name, which consists of the name and version:
1582 <literallayout class='monospaced'> 1583 <literallayout class='monospaced'>
1583 BP = ${BPN}-${PV} 1584 BP = ${BPN}-${PV}
1584 </literallayout> 1585 </literallayout>
@@ -1588,8 +1589,9 @@ directory.</para></listitem>
1588 <para> 1589 <para>
1589 The path to the work directory for the recipe 1590 The path to the work directory for the recipe
1590 (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends 1591 (<ulink url='&YOCTO_DOCS_REF_URL;#var-WORKDIR'><filename>WORKDIR</filename></ulink>) depends
1591 on the package name and the architecture of the target device. 1592 on the recipe name and the architecture of the target device.
1592 For example, here is the work directory for packages whose targets are not device-dependent: 1593 For example, here is the work directory for recipes and resulting packages that are
1594 not device-dependent:
1593 <literallayout class='monospaced'> 1595 <literallayout class='monospaced'>
1594 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1596 ${TMPDIR}/work/${PACKAGE_ARCH}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1595 </literallayout> 1597 </literallayout>
@@ -1597,14 +1599,16 @@ directory.</para></listitem>
1597 Assuming a top-level <link linkend='source-directory'>Source Directory</link> 1599 Assuming a top-level <link linkend='source-directory'>Source Directory</link>
1598 named <filename>poky</filename> 1600 named <filename>poky</filename>
1599 and a default build directory of <filename>poky/build</filename>, 1601 and a default build directory of <filename>poky/build</filename>,
1600 the following is the work directory for the <filename>acl</filename> package: 1602 the following is the work directory for the <filename>acl</filename> recipe that
1603 creates the <filename>acl</filename> package:
1601 <literallayout class='monospaced'> 1604 <literallayout class='monospaced'>
1602 ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3 1605 ~/poky/build/tmp/work/i586-poky-linux/acl-2.2.51-r3
1603 </literallayout> 1606 </literallayout>
1604 </para> 1607 </para>
1605 1608
1606 <para> 1609 <para>
1607 If your package is dependent on the target device, the work directory varies slightly: 1610 If your resulting package is dependent on the target device,
1611 the work directory varies slightly:
1608 <literallayout class='monospaced'> 1612 <literallayout class='monospaced'>
1609 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR} 1613 ${TMPDIR}/work/${MACHINE}-poky-${TARGET_OS}/${PN}-${PV}-${PR}
1610 </literallayout> 1614 </literallayout>
@@ -1633,9 +1637,9 @@ directory.</para></listitem>
1633 </note> 1637 </note>
1634 1638
1635 <para> 1639 <para>
1636 Now that you know where to locate the directory that has the temporary source code, you can use a 1640 Now that you know where to locate the directory that has the temporary source code,
1637 Quilt or Git workflow to make your edits, test the changes, and preserve the 1641 you can use a Quilt or Git workflow to make your edits, test the changes,
1638 changes in the form of patches. 1642 and preserve the changes in the form of patches.
1639 </para> 1643 </para>
1640 </section> 1644 </section>
1641 1645