From 9a71aeca42e65fe7ed3a99f1a9a3999e6a9f41fd Mon Sep 17 00:00:00 2001
From: rillig <rillig@pkgsrc.org>
Date: Sun, 2 Jul 2006 22:45:17 +0000
Subject: Summarized some places where you can find more documentation about
 pkgsrc.

---
 doc/guide/files/devfaq.xml | 52 +++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 51 insertions(+), 1 deletion(-)

(limited to 'doc/guide')

diff --git a/doc/guide/files/devfaq.xml b/doc/guide/files/devfaq.xml
index bae5ac912b7..760ff370dc5 100644
--- a/doc/guide/files/devfaq.xml
+++ b/doc/guide/files/devfaq.xml
@@ -1,4 +1,4 @@
-<!-- $NetBSD: devfaq.xml,v 1.4 2006/06/23 10:12:28 rillig Exp $ -->
+<!-- $NetBSD: devfaq.xml,v 1.5 2006/07/02 22:45:17 rillig Exp $ -->
 
 <chapter id="devfaq"> <?dbhtml filename="devfaq.html"?>
 <title>Frequently Asked Questions</title>
@@ -126,6 +126,56 @@
 	</variablelist></answer>
 
 </qandaentry>
+<qandaentry>
+
+	<question><para>Where is the pkgsrc
+	documentation?</para></question>
+
+	<answer><para>There are many places where you can find
+	documentation about pkgsrc:</para>
+
+	<itemizedlist>
+
+	<listitem><para>The pkgsrc guide (this document) is a collection
+	of chapters that explain large parts of pkgsrc, but some
+	chapters tend to be outdated. Which ones they are is hard to
+	say.</para></listitem>
+
+	<listitem><para>On the mailing list archives (see <ulink
+	url="http://mail-index.NetBSD.org/"/>), you can find discussions
+	about certain features, announcements of new parts of the pkgsrc
+	infrastructure and sometimes even announcements that a certain
+	feature has been marked as obsolete. The benefit here is that
+	each message has a date appended to it.</para></listitem>
+
+	<listitem><para>Many of the files in the
+	<filename>mk/</filename> directory start with a comment that
+	describes the purpose of the file and how it can be used by the
+	pkgsrc user and package authors.</para></listitem>
+
+	<listitem><para>The CVS log messages are a rich source of
+	information, but they tend to be highly abbreviated, especially
+	for actions that occur often. Some contain a detailed
+	description of what has changed, but they are geared towards the
+	other pkgsrc developers, not towards an average pkgsrc user.
+	They also only document <emphasis>changes</emphasis>, so if you
+	don't know what has been before, these messages may not be worth
+	too much to you.</para></listitem>
+
+	<listitem><para>Some parts of pkgsrc are only <quote>implicitly
+	documented</quote>, that is the documentation exists only in the
+	mind of the developer who wrote the code. To get this
+	information, use the the <command>cvs annotate</command> command
+	to see who has written it and ask on the
+	<literal>tech-pkg</literal> mailing list, so that others can
+	find your questions later (see above). To be sure that the
+	developer in charge reads the mail, you may CC him or
+	her.</para></listitem>
+
+	</itemizedlist>
+
+	</answer>
 
+</qandaentry>
 </qandaset>
 </chapter>
-- 
cgit v1.2.3