pkgsrc-Changes-HG archive

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]

[pkgsrc/trunk]: pkgsrc/doc/guide/files doc/guide: add chapters for getting help



details:   https://anonhg.NetBSD.org/pkgsrc/rev/4e75b16af519
branches:  trunk
changeset: 333007:4e75b16af519
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Apr 28 13:41:18 2019 +0000

description:
doc/guide: add chapters for getting help

diffstat:

 doc/guide/files/Makefile       |   4 +++-
 doc/guide/files/chapters.ent   |   4 +++-
 doc/guide/files/help-devel.xml |  38 ++++++++++++++++++++++++++++++++++++++
 doc/guide/files/help-user.xml  |  29 +++++++++++++++++++++++++++++
 doc/guide/files/pkgsrc.xml     |   6 ++++--
 5 files changed, 77 insertions(+), 4 deletions(-)

diffs (154 lines):

diff -r 5cc24978f271 -r 4e75b16af519 doc/guide/files/Makefile
--- a/doc/guide/files/Makefile  Sun Apr 28 13:39:05 2019 +0000
+++ b/doc/guide/files/Makefile  Sun Apr 28 13:41:18 2019 +0000
@@ -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+= 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
diff -r 5cc24978f271 -r 4e75b16af519 doc/guide/files/chapters.ent
--- a/doc/guide/files/chapters.ent      Sun Apr 28 13:39:05 2019 +0000
+++ b/doc/guide/files/chapters.ent      Sun Apr 28 13:41:18 2019 +0000
@@ -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">
diff -r 5cc24978f271 -r 4e75b16af519 doc/guide/files/help-devel.xml
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/guide/files/help-devel.xml    Sun Apr 28 13:41:18 2019 +0000
@@ -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>
diff -r 5cc24978f271 -r 4e75b16af519 doc/guide/files/help-user.xml
--- /dev/null   Thu Jan 01 00:00:00 1970 +0000
+++ b/doc/guide/files/help-user.xml     Sun Apr 28 13:41:18 2019 +0000
@@ -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>
diff -r 5cc24978f271 -r 4e75b16af519 doc/guide/files/pkgsrc.xml
--- a/doc/guide/files/pkgsrc.xml        Sun Apr 28 13:39:05 2019 +0000
+++ b/doc/guide/files/pkgsrc.xml        Sun Apr 28 13:41:18 2019 +0000
@@ -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;



Home | Main Index | Thread Index | Old Index