summaryrefslogtreecommitdiff
path: root/doc/guide
diff options
context:
space:
mode:
authorrillig <rillig@pkgsrc.org>2019-04-28 13:41:18 +0000
committerrillig <rillig@pkgsrc.org>2019-04-28 13:41:18 +0000
commitc178b464195a8d380b90b50dd9d07dbf2e420ba1 (patch)
treed4848ff8bd6c44900c8d98b1129604ef402c8b85 /doc/guide
parent53b31575ff16a61ca77f821f440482e8a6c3cd21 (diff)
downloadpkgsrc-c178b464195a8d380b90b50dd9d07dbf2e420ba1.tar.gz
doc/guide: add chapters for getting help
Diffstat (limited to 'doc/guide')
-rw-r--r--doc/guide/files/Makefile4
-rw-r--r--doc/guide/files/chapters.ent4
-rw-r--r--doc/guide/files/help-devel.xml38
-rw-r--r--doc/guide/files/help-user.xml29
-rw-r--r--doc/guide/files/pkgsrc.xml6
5 files changed, 77 insertions, 4 deletions
diff --git a/doc/guide/files/Makefile b/doc/guide/files/Makefile
index 2ccf735abc4..a0f9126f8c0 100644
--- a/doc/guide/files/Makefile
+++ b/doc/guide/files/Makefile
@@ -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
diff --git a/doc/guide/files/chapters.ent b/doc/guide/files/chapters.ent
index 3827739df8c..ea1a4df7343 100644
--- a/doc/guide/files/chapters.ent
+++ b/doc/guide/files/chapters.ent
@@ -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 --git a/doc/guide/files/help-devel.xml b/doc/guide/files/help-devel.xml
new file mode 100644
index 00000000000..e1e685f332f
--- /dev/null
+++ b/doc/guide/files/help-devel.xml
@@ -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">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 --git a/doc/guide/files/help-user.xml b/doc/guide/files/help-user.xml
new file mode 100644
index 00000000000..a710fd5bb76
--- /dev/null
+++ b/doc/guide/files/help-user.xml
@@ -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">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 --git a/doc/guide/files/pkgsrc.xml b/doc/guide/files/pkgsrc.xml
index 7acdae56eaf..29793d111ef 100644
--- a/doc/guide/files/pkgsrc.xml
+++ b/doc/guide/files/pkgsrc.xml
@@ -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">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;