summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorScott Rifenbark <scott.m.rifenbark@intel.com>2014-03-26 08:12:43 -0600
committerRichard Purdie <richard.purdie@linuxfoundation.org>2014-03-30 10:18:37 +0100
commitaa73618df5474f1c51c0c37a32831d04e8435cc9 (patch)
tree052d547f8e9dad11c481388fdd0be166574624d8
parentff5b58e612fc3778011ea0b0d384ae414a616f38 (diff)
downloadpoky-aa73618df5474f1c51c0c37a32831d04e8435cc9.tar.gz
dev-manual, ref-manual: Noting TMPDIR cannot be on NFS
Fixes [YOCTO #5442] Updated the TMPDIR variable to call out the scenario where a user might want to separtely set TMPDIR to a local drive and thus be able to have the Build Directory on NFS. Updated the "Build Directory" term with a note indicating that by default, TMPDIR is inside the Build Directory and thus cannot be on NFS. However, the user is able to by-pass that per setting TMPDIR separately outside of the Build Directory. (From yocto-docs rev: a5a308c512a3f4285bce16f17974dbf6b67432b2) Signed-off-by: Scott Rifenbark <scott.m.rifenbark@intel.com> Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
-rw-r--r--documentation/dev-manual/dev-manual-newbie.xml24
-rw-r--r--documentation/ref-manual/ref-variables.xml3
2 files changed, 23 insertions, 4 deletions
diff --git a/documentation/dev-manual/dev-manual-newbie.xml b/documentation/dev-manual/dev-manual-newbie.xml
index 1245345cc4..3d4a9b225f 100644
--- a/documentation/dev-manual/dev-manual-newbie.xml
+++ b/documentation/dev-manual/dev-manual-newbie.xml
@@ -520,9 +520,10 @@
520 </para></listitem> 520 </para></listitem>
521 <listitem> 521 <listitem>
522 <para id='build-directory'><emphasis>Build Directory:</emphasis> 522 <para id='build-directory'><emphasis>Build Directory:</emphasis>
523 This term refers to the area used by the OpenEmbedded build system for builds. 523 This term refers to the area used by the OpenEmbedded build
524 The area is created when you <filename>source</filename> the setup 524 system for builds.
525 environment script that is found in the Source Directory 525 The area is created when you <filename>source</filename> the
526 setup environment script that is found in the Source Directory
526 (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink> 527 (i.e. <ulink url='&YOCTO_DOCS_REF_URL;#structure-core-script'><filename>&OE_INIT_FILE;</filename></ulink>
527 or 528 or
528 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>). 529 <ulink url='&YOCTO_DOCS_REF_URL;#structure-memres-core-script'><filename>oe-init-build-env-memres</filename></ulink>).
@@ -566,7 +567,22 @@
566 $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION; 567 $ source $HOME/poky/&OE_INIT_FILE; $HOME/mybuilds/YP-&POKYVERSION;
567 </literallayout></para></listitem> 568 </literallayout></para></listitem>
568 </itemizedlist> 569 </itemizedlist>
569 </para></listitem> 570 <note>
571 By default, the Build Directory contains
572 <ulink url='&YOCTO_DOCS_REF_URL;#var-TMPDIR'><filename>TMPDIR</filename></ulink>,
573 which is a temporary directory the build system uses for
574 its work.
575 <filename>TMPDIR</filename> cannot be under NFS.
576 Thus, by default, the Build Directory cannot be under NFS.
577 However, if you need the Build Directory to be under NFS,
578 you can set this up by setting <filename>TMPDIR</filename>
579 in your <filename>local.conf</filename> file
580 to use a local drive.
581 Doing so effectively separates <filename>TMPDIR</filename>
582 from <filename>TOPDIR</filename>, which is the Build
583 Directory.
584 </note>
585 </para></listitem>
570 <listitem><para id='build-system-term'><emphasis>Build System:</emphasis> 586 <listitem><para id='build-system-term'><emphasis>Build System:</emphasis>
571 In the context of the Yocto Project, 587 In the context of the Yocto Project,
572 this term refers to the OpenEmbedded build system used by the project. 588 this term refers to the OpenEmbedded build system used by the project.
diff --git a/documentation/ref-manual/ref-variables.xml b/documentation/ref-manual/ref-variables.xml
index ceb92c9cb6..7d038cb436 100644
--- a/documentation/ref-manual/ref-variables.xml
+++ b/documentation/ref-manual/ref-variables.xml
@@ -7318,6 +7318,9 @@ recipes-graphics/xorg-font/font-alias_1.0.3.bb:PR = "${INC_PR}.3"
7318 <literallayout class='monospaced'> 7318 <literallayout class='monospaced'>
7319 #TMPDIR = "${TOPDIR}/tmp" 7319 #TMPDIR = "${TOPDIR}/tmp"
7320 </literallayout> 7320 </literallayout>
7321 An example use for this scenario is to set
7322 <filename>TMPDIR</filename> to a local disk, which does
7323 not use NFS, while having the Build Directory use NFS.
7321 </para> 7324 </para>
7322 7325
7323 <para> 7326 <para>