[pkgsrc/trunk]: pkgsrc/doc/guide/files Added explanations for some of the dir...

[rillig <rillig%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/282c1771cbbc
branches:  trunk
changeset: 502257:282c1771cbbc
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Thu Nov 03 17:06:13 2005 +0000

description:
Added explanations for some of the directories used in the build
process. More will follow.

diffstat:

 doc/guide/files/build.xml |  34 +++++++++++++++++++++++++++++++++-
 1 files changed, 33 insertions(+), 1 deletions(-)

diffs (48 lines):

diff -r 8dd4e5e5d95b -r 282c1771cbbc doc/guide/files/build.xml
--- a/doc/guide/files/build.xml Thu Nov 03 17:00:38 2005 +0000
+++ b/doc/guide/files/build.xml Thu Nov 03 17:06:13 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.12 2005/11/03 16:43:59 rillig Exp $ -->
+<!-- $NetBSD: build.xml,v 1.13 2005/11/03 17:06:13 rillig Exp $ -->
 
 <chapter id="build">
 <title>The build process</title>
@@ -148,6 +148,38 @@
     </itemizedlist>
   </sect1>
 
+<sect1 id="build.builddirs">
+<title>Directories used during the build process</title>
+
+<para>When building a package, a number of directories is used to store
+source files, temporary files, pkgsrc-internal files, and so on. These
+directories are explained here.</para>
+
+<variablelist>
+
+<varlistentry><term>PKGSRCDIR</term><listitem><para>This is an absolute
+pathname that points to the pkgsrc root directory. Generally, you don't
+need it.</para></listitem></varlistentry>
+
+<varlistentry><term>PKGPATH</term><listitem><para>This is a pathname
+relative to <varname>PKGSRCDIR</varname> that points to the current
+package.</para></listitem></varlistentry>
+
+<varlistentry><term>WRKDIR</term><listitem><para>This is an absolute
+pathname pointing to the directory where all work takes place. This
+directory typically contains temporary directories used by the various
+pkgsrc frameworks, like <emphasis>buildlink</emphasis> or the
+<emphasis>wrappers</emphasis>.</para></listitem></varlistentry>
+
+<varlistentry><term>WRKSRC</term><listitem><para>This is an absolute
+pathname pointing to the directory where the distfiles are extracted. It
+is usually a direct subdirectory of <varname>WRKDIR</varname>, and often
+it's the only directory entry that doesn't start with a
+dot.</para></listitem></varlistentry>
+
+</variablelist>
+</sect1>
+
 <sect1 id="build.running">
 <title>Running a phase</title>