Added a chapter in the developer's part for frequently asked questions.

3 files changed, 72 insertions, 3 deletions

diff --git a/doc/guide/files/chapters.ent b/doc/guide/files/chapters.ent
index ef751a7bcad..69aa434dd00 100644
--- a/doc/guide/files/chapters.ent
+++ b/doc/guide/files/chapters.ent
@@ -1,7 +1,7 @@
 <!--
 	Creates entities for each chapter in the pkgsrc book.
 
-	$NetBSD: chapters.ent,v 1.8 2006/02/18 01:46:43 rillig Exp $
+	$NetBSD: chapters.ent,v 1.9 2006/05/10 13:58:34 rillig Exp $
 -->
 
 <!ENTITY chap.intro			SYSTEM "introduction.xml">
@@ -27,6 +27,7 @@
 <!ENTITY chap.debug			SYSTEM "debug.xml">
 <!ENTITY chap.submit			SYSTEM "submit.xml">
 <!ENTITY chap.porting			SYSTEM "porting.xml">
+<!ENTITY chap.devfaq			SYSTEM "devfaq.xml">
 
 <!-- appendix -->
 <!ENTITY chap.examples			SYSTEM "examples.xml">
diff --git a/doc/guide/files/devfaq.xml b/doc/guide/files/devfaq.xml
new file mode 100644
index 00000000000..4d8a0fa713e
--- /dev/null
+++ b/doc/guide/files/devfaq.xml
@@ -0,0 +1,67 @@
+<!-- $NetBSD: devfaq.xml,v 1.1 2006/05/10 13:58:34 rillig Exp $ -->
+
+<chapter id="devfaq"> <?dbhtml filename="devfaq.html"?>
+<title>Frequently Asked Questions</title>
+
+	<para>This section contains the answers to questions that may
+	arise when you are writing a package. If you don't find your
+	question answered here, first have a look in the other chapters,
+	and if you still don't have the answer, ask on the
+	<literal>pkgsrc-users</literal> mailing list.</para>
+
+<qandaset>
+<qandaentry>
+
+	<question><para>What is the difference between
+	<varname>MAKEFLAGS</varname>, <varname>.MAKEFLAGS</varname> and
+	<varname>MAKE_FLAGS</varname>?</para></question>
+
+	<answer><para><varname>MAKEFLAGS</varname> are the flags passed
+	to the pkgsrc-internal invocations of &man.make.1;, while
+	<varname>MAKE_FLAGS</varname> are the flags that are passed to
+	the <varname>MAKE_PROGRAM</varname> when building the
+	package. [FIXME: What is .MAKEFLAGS for?]</para></answer>
+
+</qandaentry>
+<qandaentry>
+
+	<question><para>What is the difference between
+	<varname>MAKE</varname>, <varname>GMAKE</varname> and
+	<varname>MAKE_PROGRAM</varname>?</para></question>
+
+	<answer><para><varname>MAKE</varname> is the path to the
+	&man.make.1; program that is used in the pkgsrc
+	infrastructure. <varname>GMAKE</varname> is the path to GNU
+	Make, but you need to say <varname>USE_TOOLS+=gmake</varname> to
+	use that. <varname>MAKE_PROGRAM</varname> is the path to the
+	Make program that is used for building the
+	package.</para></answer>
+
+</qandaentry>
+<qandaentry>
+
+	<question><para>What is the difference between
+	<varname>CC</varname>, <varname>PKG_CC</varname> and
+	<varname>PKGSRC_COMPILER</varname>?</para></question>
+
+	<answer><para><varname>CC</varname> is the path to the real C
+	compiler, which can be configured by the pkgsrc user.
+	<varname>PKG_CC</varname> is the path to the compiler wrapper.
+	<varname>PKGSRC_COMPILER</varname> is <emphasis>not</emphasis> a
+	path to a compiler, but the type of compiler that should be
+	used. See <filename>mk/compiler.mk</filename> for more
+	information about the latter variable.</para></answer>
+
+</qandaentry>
+<qandaentry>
+
+	<question><para>What is the difference between
+	<varname>BUILDLINK_LDFLAGS</varname>,
+	<varname>BUILDLINK_LDADD</varname> and
+	<varname>BUILDLINK_LIBS</varname>?</para></question>
+
+	<answer><para>[FIXME]</para></answer>
+
+</qandaentry>
+</qandaset>
+</chapter>
diff --git a/doc/guide/files/pkgsrc.xml b/doc/guide/files/pkgsrc.xml
index fb5ddd4eced..cac49ca5d78 100644
--- a/doc/guide/files/pkgsrc.xml
+++ b/doc/guide/files/pkgsrc.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: pkgsrc.xml,v 1.12 2006/02/18 01:46:43 rillig Exp $ -->
+<!-- $NetBSD: pkgsrc.xml,v 1.13 2006/05/10 13:58:34 rillig Exp $ -->
 
 
 <?xml version="1.0"?>
@@ -45,7 +45,7 @@
       <holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder>
     </copyright>
 
-    <pubdate>$NetBSD: pkgsrc.xml,v 1.12 2006/02/18 01:46:43 rillig Exp $</pubdate>
+    <pubdate>$NetBSD: pkgsrc.xml,v 1.13 2006/05/10 13:58:34 rillig Exp $</pubdate>
 
     <abstract>
       <para>Information about using the NetBSD package system (pkgsrc)
@@ -83,6 +83,7 @@
     &chap.debug;
     &chap.submit;
     &chap.porting;
+    &chap.devfaq;
   </part>
 
   <!-- appendix -->