summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <srifenbark@gmail.com>2016-02-23 07:22:52 -0800
committerRichard Purdie <richard.purdie@linuxfoundation.org>2016-03-03 17:40:11 +0000
commit3b410498fec06cd09731571800405320d7ff4096 (patch)
tree6a4e6f065760de6ddd1d7e7c843b48c6952a5e92
parenta1970eb17bc8fde08aeca1128d5286c0bbc88ebf (diff)
downloadpoky-3b410498fec06cd09731571800405320d7ff4096.tar.gz
ref-manual, dev-manual: Clarifying "native" and "sdknative"
Fixes [YOCTO #8620] I applied some review comments for the changes made to several areas in both these manuals. Minor wording fixes and the dropping of some changes as directed by Joshua Lock. (From yocto-docs rev: 71af89da612c37162ba27844c297879d643caf65) Signed-off-by: Scott Rifenbark <srifenbark@gmail.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-common-tasks.xml22
-rw-r--r--documentation/ref-manual/introduction.xml7
-rw-r--r--documentation/ref-manual/migration.xml7
-rw-r--r--documentation/ref-manual/ref-classes.xml9
-rw-r--r--documentation/ref-manual/technical-details.xml7
5 files changed, 27 insertions, 25 deletions
diff --git a/documentation/dev-manual/dev-manual-common-tasks.xml b/documentation/dev-manual/dev-manual-common-tasks.xml
index ba182acaf4..ddff77cdc2 100644
--- a/documentation/dev-manual/dev-manual-common-tasks.xml
+++ b/documentation/dev-manual/dev-manual-common-tasks.xml
@@ -3603,11 +3603,10 @@
3603 <title>Additional Implementation Details</title> 3603 <title>Additional Implementation Details</title>
3604 3604
3605 <para> 3605 <para>
3606 Different packaging systems have different levels of 3606 Different packaging systems have different levels of native Multilib
3607 native Multilib support (i.e. support for the host build 3607 support.
3608 machine). 3608 For the RPM Package Management System, the following implementation details
3609 For the RPM Package Management System, the following 3609 exist:
3610 implementation details exist:
3611 <itemizedlist> 3610 <itemizedlist>
3612 <listitem><para>A unique architecture is defined for the Multilib packages, 3611 <listitem><para>A unique architecture is defined for the Multilib packages,
3613 along with creating a unique deploy folder under 3612 along with creating a unique deploy folder under
@@ -6377,9 +6376,8 @@
6377 developers when building for multiple machines. 6376 developers when building for multiple machines.
6378 When you use the same <filename>TMPDIR</filename> for 6377 When you use the same <filename>TMPDIR</filename> for
6379 multiple machine builds, the OpenEmbedded build system can 6378 multiple machine builds, the OpenEmbedded build system can
6380 reuse the existing native (i.e. host system) and often 6379 reuse the existing native and often cross-recipes for
6381 cross-recipes (i.e. <filename>nativesdk</filename> 6380 multiple machines.
6382 for multiple machines.
6383 Thus, build time decreases. 6381 Thus, build time decreases.
6384 <note> 6382 <note>
6385 If 6383 If
@@ -7582,14 +7580,16 @@
7582 Consequently, you usually need to add a 7580 Consequently, you usually need to add a
7583 cross-compilation function to the package. 7581 cross-compilation function to the package.
7584 </para> 7582 </para>
7583
7585 <para>Many packages based on Automake compile and 7584 <para>Many packages based on Automake compile and
7586 run the test suite by using a single command 7585 run the test suite by using a single command
7587 such as <filename>make check</filename>. 7586 such as <filename>make check</filename>.
7588 However, the native <filename>make check</filename> 7587 However, the host <filename>make check</filename>
7589 that runs on the host system
7590 builds and runs on the same computer, while 7588 builds and runs on the same computer, while
7591 cross-compiling requires that the package is built 7589 cross-compiling requires that the package is built
7592 on the host but executed on the target. 7590 on the host but executed for the target
7591 architecture (though often, as in the case for
7592 ptest, the execution occurs on the host).
7593 The built version of Automake that ships with the 7593 The built version of Automake that ships with the
7594 Yocto Project includes a patch that separates 7594 Yocto Project includes a patch that separates
7595 building and execution. 7595 building and execution.
diff --git a/documentation/ref-manual/introduction.xml b/documentation/ref-manual/introduction.xml
index 750d9c681c..57e4a25853 100644
--- a/documentation/ref-manual/introduction.xml
+++ b/documentation/ref-manual/introduction.xml
@@ -450,9 +450,7 @@
450 $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 450 $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
451 </literallayout> 451 </literallayout>
452 During execution, a prompt appears that allows you to 452 During execution, a prompt appears that allows you to
453 choose the installation directory for these tools 453 choose the installation directory.
454 designed to run on the target machine
455 (<link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>).
456 For example, you could choose the following: 454 For example, you could choose the following:
457 <literallayout class='monospaced'> 455 <literallayout class='monospaced'>
458 /home/<replaceable>your-username</replaceable>/buildtools 456 /home/<replaceable>your-username</replaceable>/buildtools
@@ -532,8 +530,7 @@
532 <listitem><para> 530 <listitem><para>
533 On the machine that does not meet the requirements, 531 On the machine that does not meet the requirements,
534 run the <filename>.sh</filename> file 532 run the <filename>.sh</filename> file
535 to install the tools built to run on the target machine 533 to install the tools.
536 (<link linkend='var-SDKMACHINE'><filename>SDKMACHINE</filename></link>).
537 Here is an example: 534 Here is an example:
538 <literallayout class='monospaced'> 535 <literallayout class='monospaced'>
539 $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh 536 $ sh poky-glibc-x86_64-buildtools-tarball-x86_64-buildtools-nativesdk-standalone-&DISTRO;.sh
diff --git a/documentation/ref-manual/migration.xml b/documentation/ref-manual/migration.xml
index 62f792bf7b..6fc39d0b56 100644
--- a/documentation/ref-manual/migration.xml
+++ b/documentation/ref-manual/migration.xml
@@ -193,9 +193,10 @@
193 as a prefix, which simplifies a lot of the packaging code for 193 as a prefix, which simplifies a lot of the packaging code for
194 <filename>nativesdk</filename> recipes. 194 <filename>nativesdk</filename> recipes.
195 All custom <filename>nativesdk</filename> recipes, which are 195 All custom <filename>nativesdk</filename> recipes, which are
196 recipes built on the host system to create packages for the 196 relocatable packages for the native architecture as specified
197 target machine, and any 197 in
198 references need to be updated to use 198 <link linkend='var-SDK_ARCH'><filename>SDK_ARCH</filename></link>,
199 and any references need to be updated to use
199 <filename>nativesdk-*</filename> instead of 200 <filename>nativesdk-*</filename> instead of
200 <filename>*-nativesdk</filename>. 201 <filename>*-nativesdk</filename>.
201 </para> 202 </para>
diff --git a/documentation/ref-manual/ref-classes.xml b/documentation/ref-manual/ref-classes.xml
index f994a2269d..c4f15c9f9d 100644
--- a/documentation/ref-manual/ref-classes.xml
+++ b/documentation/ref-manual/ref-classes.xml
@@ -463,11 +463,10 @@
463 463
464 <para> 464 <para>
465 The <filename>chrpath</filename> class 465 The <filename>chrpath</filename> class
466 is a wrapper around the "chrpath" utility. 466 is a wrapper around the "chrpath" utility, which is used during the
467 This utility is used during the build process for 467 build process for <filename>nativesdk</filename>,
468 <filename>nativesdk</filename>, <filename>cross</filename>, and 468 <filename>cross</filename>, and
469 <filename>cross-canadian</filename> recipes, which run on the host 469 <filename>cross-canadian</filename> recipes to change
470 system to create packages for the target hardware and change
471 <filename>RPATH</filename> records within binaries in order to make 470 <filename>RPATH</filename> records within binaries in order to make
472 them relocatable. 471 them relocatable.
473 </para> 472 </para>
diff --git a/documentation/ref-manual/technical-details.xml b/documentation/ref-manual/technical-details.xml
index b4f6a832ed..e26994503b 100644
--- a/documentation/ref-manual/technical-details.xml
+++ b/documentation/ref-manual/technical-details.xml
@@ -477,7 +477,12 @@
477 It does not matter if the work directory changes because it should 477 It does not matter if the work directory changes because it should
478 not affect the output for target packages. 478 not affect the output for target packages.
479 Also, the build process has the objective of making native 479 Also, the build process has the objective of making native
480 (build host) or cross packages (target hardware) relocatable. 480 or cross packages relocatable.
481 <note>
482 Both native and cross packages run on the build host.
483 However, cross packages generate output for the target
484 architecture.
485 </note>
481 The checksum therefore needs to exclude 486 The checksum therefore needs to exclude
482 <filename>WORKDIR</filename>. 487 <filename>WORKDIR</filename>.
483 The simplistic approach for excluding the work directory is to set 488 The simplistic approach for excluding the work directory is to set