CVS commit: pkgsrc/doc/guide/files

["Roland Illig" <rillig%netbsd.org@localhost>]

Module Name:    pkgsrc
Committed By:   rillig
Date:           Sun Apr 28 13:41:18 UTC 2019

Modified Files:
        pkgsrc/doc/guide/files: Makefile chapters.ent pkgsrc.xml
Added Files:
        pkgsrc/doc/guide/files: help-devel.xml help-user.xml

Log Message:
doc/guide: add chapters for getting help


To generate a diff of this commit:
cvs rdiff -u -r1.17 -r1.18 pkgsrc/doc/guide/files/Makefile \
    pkgsrc/doc/guide/files/chapters.ent
cvs rdiff -u -r0 -r1.1 pkgsrc/doc/guide/files/help-devel.xml \
    pkgsrc/doc/guide/files/help-user.xml
cvs rdiff -u -r1.33 -r1.34 pkgsrc/doc/guide/files/pkgsrc.xml

Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.

Modified files:

Index: pkgsrc/doc/guide/files/Makefile
diff -u pkgsrc/doc/guide/files/Makefile:1.17 pkgsrc/doc/guide/files/Makefile:1.18
--- pkgsrc/doc/guide/files/Makefile:1.17        Sat Jun 11 18:14:42 2016
+++ pkgsrc/doc/guide/files/Makefile     Sun Apr 28 13:41:18 2019
@@ -1,4 +1,4 @@
-# $NetBSD: Makefile,v 1.17 2016/06/11 18:14:42 rillig Exp $
+# $NetBSD: Makefile,v 1.18 2019/04/28 13:41:18 rillig Exp $
 
 WEB_PREFIX?=           ${.CURDIR}/../htdocs
 DBX_XML_CATALOG?=      ${SGML_PREFIX}/docbook/4.5/catalog.xml
@@ -24,6 +24,8 @@ SRCS+=        files.xml
 SRCS+= fixes.xml
 SRCS+= ftp-layout.xml
 SRCS+= getting.xml
+SRCS+= help-devel.xml
+SRCS+= help-user.xml
 SRCS+= infr.design.xml
 SRCS+= introduction.xml
 SRCS+= logs.xml
Index: pkgsrc/doc/guide/files/chapters.ent
diff -u pkgsrc/doc/guide/files/chapters.ent:1.17 pkgsrc/doc/guide/files/chapters.ent:1.18
--- pkgsrc/doc/guide/files/chapters.ent:1.17    Tue Sep 18 08:17:21 2007
+++ pkgsrc/doc/guide/files/chapters.ent Sun Apr 28 13:41:18 2019
@@ -1,12 +1,13 @@
 <!--
        Creates entities for each chapter in the pkgsrc book.
 
-       $NetBSD: chapters.ent,v 1.17 2007/09/18 08:17:21 rillig Exp $
+       $NetBSD: chapters.ent,v 1.18 2019/04/28 13:41:18 rillig Exp $
 -->
 
 <!ENTITY chap.intro                    SYSTEM "introduction.xml">
 
 <!-- user's guide -->
+<!ENTITY chap.help-user                        SYSTEM "help-user.xml">
 <!ENTITY chap.getting                  SYSTEM "getting.xml">
 <!ENTITY chap.platform                 SYSTEM "platforms.xml">
 <!ENTITY chap.using                    SYSTEM "using.xml">
@@ -17,6 +18,7 @@
 <!ENTITY chap.faq                      SYSTEM "faq.xml">
 
 <!-- developer's guide -->
+<!ENTITY chap.help-devel               SYSTEM "help-devel.xml">
 <!ENTITY chap.creating                 SYSTEM "creating.xml">
 <!ENTITY chap.components               SYSTEM "components.xml">
 <!ENTITY chap.makefile                 SYSTEM "makefile.xml">

Index: pkgsrc/doc/guide/files/pkgsrc.xml
diff -u pkgsrc/doc/guide/files/pkgsrc.xml:1.33 pkgsrc/doc/guide/files/pkgsrc.xml:1.34
--- pkgsrc/doc/guide/files/pkgsrc.xml:1.33      Tue Jan  1 02:50:23 2019
+++ pkgsrc/doc/guide/files/pkgsrc.xml   Sun Apr 28 13:41:18 2019
@@ -1,5 +1,5 @@
 <?xml version="1.0"?>
-<!-- $NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $ -->
+<!-- $NetBSD: pkgsrc.xml,v 1.34 2019/04/28 13:41:18 rillig Exp $ -->
 
 <!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.5-Based DocBook Extension//EN" [
 
@@ -47,7 +47,7 @@
       <holder role="mailto:www%NetBSD.org@localhost";>The NetBSD Foundation, Inc</holder>
     </copyright>
 
-    <pubdate>$NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $</pubdate>
+    <pubdate>$NetBSD: pkgsrc.xml,v 1.34 2019/04/28 13:41:18 rillig Exp $</pubdate>
 
     <abstract>
 
@@ -65,6 +65,7 @@
   <part id="users-guide"> <?dbhtml filename="users-guide.html"?>
     <title id="users-guide.title">The pkgsrc user's guide</title>
 
+    &chap.help-user;
     &chap.getting;
     &chap.platform;
     &chap.using;
@@ -84,6 +85,7 @@
        guide on creating a new package. The remaining chapters are more
        like a reference manual for pkgsrc.</para></partintro>
 
+    &chap.help-devel;
     &chap.creating;
     &chap.components;
     &chap.makefile;

Added files:

Index: pkgsrc/doc/guide/files/help-devel.xml
diff -u /dev/null pkgsrc/doc/guide/files/help-devel.xml:1.1
--- /dev/null   Sun Apr 28 13:41:18 2019
+++ pkgsrc/doc/guide/files/help-devel.xml       Sun Apr 28 13:41:18 2019
@@ -0,0 +1,38 @@
+<!-- $NetBSD: help-devel.xml,v 1.1 2019/04/28 13:41:18 rillig Exp $ -->
+
+<chapter id="help-devel">
+<title>Getting help</title>
+
+<para>
+       To get help when developing pkgsrc, the definitive source is this
+       document, the pkgsrc guide. If you don't find anything here,
+       there are alternatives:
+</para>
+
+<itemizedlist>
+<listitem><para>
+       The built-in pkgsrc help, which is available after bootstrapping
+       pkgsrc. Run <command>bmake help topic=&#x2026;</command> to get
+       help for any topic, such as a variable name like
+       <varname>BUILD_DEFS</varname>, a make target like
+       <command>do-build</command>, a missing C or C++ function like
+       <command>strcasecmp</command> or any other topic.</para>
+</listitem>
+
+<listitem><para>
+       The tech-pkg mailing list, to which
+       <ulink url="https://www.NetBSD.org/mailinglists/#tech-pkg";>you
+       can subscribe</ulink> and then <ulink
+               url="mailto:tech-pkg%NetBSD.org@localhost";>ask your
+       questions</ulink>.</para>
+</listitem>
+
+<listitem><para>The #pkgsrc IRC channel, which is accessible
+       <ulink url="https://webchat.freenode.net/";>via a web browser</ulink>
+       or by using a specialized chat program such as
+       <ulink url="http://xchat.org/";>XChat</ulink>.
+       Pick any user name and join the channel #pkgsrc.</para>
+</listitem>
+</itemizedlist>
+
+</chapter>
Index: pkgsrc/doc/guide/files/help-user.xml
diff -u /dev/null pkgsrc/doc/guide/files/help-user.xml:1.1
--- /dev/null   Sun Apr 28 13:41:18 2019
+++ pkgsrc/doc/guide/files/help-user.xml        Sun Apr 28 13:41:18 2019
@@ -0,0 +1,29 @@
+<!-- $NetBSD: help-user.xml,v 1.1 2019/04/28 13:41:18 rillig Exp $ -->
+
+<chapter id="help-user">
+<title>Getting help</title>
+
+<para>
+       To get help when using pkgsrc, the definitive source is this
+       document, the pkgsrc guide. If you don't find anything here,
+       there are alternatives:
+</para>
+
+<itemizedlist>
+<listitem><para>
+       The pkgsrc-users mailing list, to which
+       <ulink url="https://www.NetBSD.org/mailinglists/#pkgsrc-users";>you
+       can subscribe</ulink> and then <ulink
+       url="mailto:pkgsrc-users%NetBSD.org@localhost";>ask your
+       questions</ulink>.</para>
+</listitem>
+
+<listitem><para>The #pkgsrc IRC channel, which is accessible
+       <ulink url="https://webchat.freenode.net/";>via a web browser</ulink>
+       or by using a specialized chat program such as
+       <ulink url="http://xchat.org/";>XChat</ulink>.
+       Pick any user name and join the channel #pkgsrc.</para>
+</listitem>
+</itemizedlist>
+
+</chapter>