[pkgsrc/trunk]: pkgsrc/doc/guide/files Summarized some places where you can f...

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

details:   https://anonhg.NetBSD.org/pkgsrc/rev/385f48b6c704
branches:  trunk
changeset: 515486:385f48b6c704
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Jul 02 22:45:17 2006 +0000

description:
Summarized some places where you can find more documentation about pkgsrc.

diffstat:

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

diffs (66 lines):

diff -r ace3b9a15939 -r 385f48b6c704 doc/guide/files/devfaq.xml
--- a/doc/guide/files/devfaq.xml        Sun Jul 02 20:35:53 2006 +0000
+++ b/doc/guide/files/devfaq.xml        Sun Jul 02 22:45:17 2006 +0000
@@ -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>