diff options
| author | rillig <rillig@pkgsrc.org> | 2005-11-03 17:06:13 +0000 |
|---|---|---|
| committer | rillig <rillig@pkgsrc.org> | 2005-11-03 17:06:13 +0000 |
| commit | 69b1807a43da187c15ad6f54b570bb2eb4d36e81 (patch) | |
| tree | 77e81f03e8df7f56581f8161e0c0b7a85226d57e | |
| parent | 620e73b89a3e15116ee1f5eaac9296b82f6b21c0 (diff) | |
| download | pkgsrc-69b1807a43da187c15ad6f54b570bb2eb4d36e81.tar.gz | |
Added explanations for some of the directories used in the build
process. More will follow.
| -rw-r--r-- | doc/guide/files/build.xml | 34 |
1 files changed, 33 insertions, 1 deletions
diff --git a/doc/guide/files/build.xml b/doc/guide/files/build.xml index 01667c73ac9..9eaddfd505f 100644 --- a/doc/guide/files/build.xml +++ b/doc/guide/files/build.xml @@ -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 @@ of the actual work is done in the <varname>do-*</varname> stages.</para> </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> |