Sun Apr 28 13:41:18 2019 UTC ()
doc/guide: add chapters for getting help


(rillig)
diff -r1.17 -r1.18 pkgsrc/doc/guide/files/Makefile
diff -r1.17 -r1.18 pkgsrc/doc/guide/files/chapters.ent
diff -r0 -r1.1 pkgsrc/doc/guide/files/help-devel.xml
diff -r0 -r1.1 pkgsrc/doc/guide/files/help-user.xml
diff -r1.33 -r1.34 pkgsrc/doc/guide/files/pkgsrc.xml
cvs diff -r1.17 -r1.18 pkgsrc/doc/guide/files/Makefile (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/Makefile 2016/06/11 18:14:42 1.17
+++ pkgsrc/doc/guide/files/Makefile 2019/04/28 13:41:18 1.18
@@ -1,39 +1,41 @@ @@ -1,39 +1,41 @@
1# $NetBSD: Makefile,v 1.17 2016/06/11 18:14:42 rillig Exp $ 1# $NetBSD: Makefile,v 1.18 2019/04/28 13:41:18 rillig Exp $
2 2
3WEB_PREFIX?= ${.CURDIR}/../htdocs 3WEB_PREFIX?= ${.CURDIR}/../htdocs
4DBX_XML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog.xml 4DBX_XML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog.xml
5DBX_XML_DTD?= ${XML_PREFIX}/docbook/4.5/docbookx.dtd 5DBX_XML_DTD?= ${XML_PREFIX}/docbook/4.5/docbookx.dtd
6DBX_SGML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog 6DBX_SGML_CATALOG?= ${SGML_PREFIX}/docbook/4.5/catalog
7 7
8DOC= pkgsrc 8DOC= pkgsrc
9 9
10SRCS= pkgsrc.xml 10SRCS= pkgsrc.xml
11SRCS+= binary.xml 11SRCS+= binary.xml
12SRCS+= build.xml 12SRCS+= build.xml
13SRCS+= buildlink.xml 13SRCS+= buildlink.xml
14SRCS+= bulk.xml 14SRCS+= bulk.xml
15SRCS+= creating.xml 15SRCS+= creating.xml
16SRCS+= components.xml 16SRCS+= components.xml
17SRCS+= configuring.xml 17SRCS+= configuring.xml
18SRCS+= debug.xml 18SRCS+= debug.xml
19SRCS+= devfaq.xml 19SRCS+= devfaq.xml
20SRCS+= editing.xml 20SRCS+= editing.xml
21SRCS+= examples.xml 21SRCS+= examples.xml
22SRCS+= faq.xml 22SRCS+= faq.xml
23SRCS+= files.xml 23SRCS+= files.xml
24SRCS+= fixes.xml 24SRCS+= fixes.xml
25SRCS+= ftp-layout.xml 25SRCS+= ftp-layout.xml
26SRCS+= getting.xml 26SRCS+= getting.xml
 27SRCS+= help-devel.xml
 28SRCS+= help-user.xml
27SRCS+= infr.design.xml 29SRCS+= infr.design.xml
28SRCS+= introduction.xml 30SRCS+= introduction.xml
29SRCS+= logs.xml 31SRCS+= logs.xml
30SRCS+= makefile.xml 32SRCS+= makefile.xml
31SRCS+= options.xml 33SRCS+= options.xml
32SRCS+= pkginstall.xml 34SRCS+= pkginstall.xml
33SRCS+= platforms.xml 35SRCS+= platforms.xml
34SRCS+= plist.xml 36SRCS+= plist.xml
35SRCS+= porting.xml 37SRCS+= porting.xml
36SRCS+= regression.xml 38SRCS+= regression.xml
37SRCS+= submit.xml 39SRCS+= submit.xml
38SRCS+= tools.xml 40SRCS+= tools.xml
39SRCS+= using.xml 41SRCS+= using.xml
cvs diff -r1.17 -r1.18 pkgsrc/doc/guide/files/chapters.ent (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/chapters.ent 2007/09/18 08:17:21 1.17
+++ pkgsrc/doc/guide/files/chapters.ent 2019/04/28 13:41:18 1.18
@@ -1,32 +1,34 @@ @@ -1,32 +1,34 @@
1<!-- 1<!--
2 Creates entities for each chapter in the pkgsrc book. 2 Creates entities for each chapter in the pkgsrc book.
3 3
4 $NetBSD: chapters.ent,v 1.17 2007/09/18 08:17:21 rillig Exp $ 4 $NetBSD: chapters.ent,v 1.18 2019/04/28 13:41:18 rillig Exp $
5--> 5-->
6 6
7<!ENTITY chap.intro SYSTEM "introduction.xml"> 7<!ENTITY chap.intro SYSTEM "introduction.xml">
8 8
9<!-- user's guide --> 9<!-- user's guide -->
 10<!ENTITY chap.help-user SYSTEM "help-user.xml">
10<!ENTITY chap.getting SYSTEM "getting.xml"> 11<!ENTITY chap.getting SYSTEM "getting.xml">
11<!ENTITY chap.platform SYSTEM "platforms.xml"> 12<!ENTITY chap.platform SYSTEM "platforms.xml">
12<!ENTITY chap.using SYSTEM "using.xml"> 13<!ENTITY chap.using SYSTEM "using.xml">
13<!ENTITY chap.configuring SYSTEM "configuring.xml"> 14<!ENTITY chap.configuring SYSTEM "configuring.xml">
14<!ENTITY chap.binary SYSTEM "binary.xml"> 15<!ENTITY chap.binary SYSTEM "binary.xml">
15<!ENTITY chap.bulk SYSTEM "bulk.xml"> 16<!ENTITY chap.bulk SYSTEM "bulk.xml">
16<!ENTITY chap.files SYSTEM "files.xml"> 17<!ENTITY chap.files SYSTEM "files.xml">
17<!ENTITY chap.faq SYSTEM "faq.xml"> 18<!ENTITY chap.faq SYSTEM "faq.xml">
18 19
19<!-- developer's guide --> 20<!-- developer's guide -->
 21<!ENTITY chap.help-devel SYSTEM "help-devel.xml">
20<!ENTITY chap.creating SYSTEM "creating.xml"> 22<!ENTITY chap.creating SYSTEM "creating.xml">
21<!ENTITY chap.components SYSTEM "components.xml"> 23<!ENTITY chap.components SYSTEM "components.xml">
22<!ENTITY chap.makefile SYSTEM "makefile.xml"> 24<!ENTITY chap.makefile SYSTEM "makefile.xml">
23<!ENTITY chap.plist SYSTEM "plist.xml"> 25<!ENTITY chap.plist SYSTEM "plist.xml">
24<!ENTITY chap.buildlink SYSTEM "buildlink.xml"> 26<!ENTITY chap.buildlink SYSTEM "buildlink.xml">
25<!ENTITY chap.pkginstall SYSTEM "pkginstall.xml"> 27<!ENTITY chap.pkginstall SYSTEM "pkginstall.xml">
26<!ENTITY chap.options SYSTEM "options.xml"> 28<!ENTITY chap.options SYSTEM "options.xml">
27<!ENTITY chap.build SYSTEM "build.xml"> 29<!ENTITY chap.build SYSTEM "build.xml">
28<!ENTITY chap.tools SYSTEM "tools.xml"> 30<!ENTITY chap.tools SYSTEM "tools.xml">
29<!ENTITY chap.fixes SYSTEM "fixes.xml"> 31<!ENTITY chap.fixes SYSTEM "fixes.xml">
30<!ENTITY chap.debug SYSTEM "debug.xml"> 32<!ENTITY chap.debug SYSTEM "debug.xml">
31<!ENTITY chap.submit SYSTEM "submit.xml"> 33<!ENTITY chap.submit SYSTEM "submit.xml">
32<!ENTITY chap.devfaq SYSTEM "devfaq.xml"> 34<!ENTITY chap.devfaq SYSTEM "devfaq.xml">
File Added: pkgsrc/doc/guide/files/help-devel.xml
<!-- $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>
File Added: pkgsrc/doc/guide/files/help-user.xml
<!-- $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>
cvs diff -r1.33 -r1.34 pkgsrc/doc/guide/files/pkgsrc.xml (expand / switch to unified diff)

--- pkgsrc/doc/guide/files/pkgsrc.xml 2019/01/01 02:50:23 1.33
+++ pkgsrc/doc/guide/files/pkgsrc.xml 2019/04/28 13:41:18 1.34
@@ -1,15 +1,15 @@ @@ -1,15 +1,15 @@
1<?xml version="1.0"?> 1<?xml version="1.0"?>
2<!-- $NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $ --> 2<!-- $NetBSD: pkgsrc.xml,v 1.34 2019/04/28 13:41:18 rillig Exp $ -->
3 3
4<!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.5-Based DocBook Extension//EN" [ 4<!DOCTYPE book PUBLIC "-//NetBSD//DTD DocBook XML V4.5-Based DocBook Extension//EN" [
5 5
6<!ENTITY % man-refs.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Manual Page Entities//EN"> 6<!ENTITY % man-refs.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Manual Page Entities//EN">
7%man-refs.ent; 7%man-refs.ent;
8<!ENTITY % misc.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Miscellaneous Entities//EN"> 8<!ENTITY % misc.ent PUBLIC "-//NetBSD//ENTITIES NetBSD Miscellaneous Entities//EN">
9%misc.ent; 9%misc.ent;
10<!ENTITY % chapters SYSTEM "chapters.ent"> 10<!ENTITY % chapters SYSTEM "chapters.ent">
11%chapters; 11%chapters;
12<!ENTITY % entities SYSTEM "pkgsrc.ent"> 12<!ENTITY % entities SYSTEM "pkgsrc.ent">
13%entities; 13%entities;
14]> 14]>
15 15
@@ -37,63 +37,65 @@ @@ -37,63 +37,65 @@
37 </affiliation> 37 </affiliation>
38 </author> 38 </author>
39 <corpauthor> 39 <corpauthor>
40 The pkgsrc Developers 40 The pkgsrc Developers
41 </corpauthor> 41 </corpauthor>
42 </authorgroup> 42 </authorgroup>
43 43
44 <copyright> 44 <copyright>
45 <year>1994-2019</year> 45 <year>1994-2019</year>
46 46
47 <holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder> 47 <holder role="mailto:www@NetBSD.org">The NetBSD Foundation, Inc</holder>
48 </copyright> 48 </copyright>
49 49
50 <pubdate>$NetBSD: pkgsrc.xml,v 1.33 2019/01/01 02:50:23 jnemeth Exp $</pubdate> 50 <pubdate>$NetBSD: pkgsrc.xml,v 1.34 2019/04/28 13:41:18 rillig Exp $</pubdate>
51 51
52 <abstract> 52 <abstract>
53 53
54 <para>pkgsrc is a centralized package management system for 54 <para>pkgsrc is a centralized package management system for
55 Unix-like operating systems. This guide provides information for 55 Unix-like operating systems. This guide provides information for
56 users and developers of pkgsrc. It covers installation of binary 56 users and developers of pkgsrc. It covers installation of binary
57 and source packages, creation of binary and source packages and 57 and source packages, creation of binary and source packages and
58 a high-level overview about the infrastructure.</para> 58 a high-level overview about the infrastructure.</para>
59 59
60 </abstract> 60 </abstract>
61 </bookinfo> 61 </bookinfo>
62 62
63 &chap.intro; 63 &chap.intro;
64 64
65 <part id="users-guide"> <?dbhtml filename="users-guide.html"?> 65 <part id="users-guide"> <?dbhtml filename="users-guide.html"?>
66 <title id="users-guide.title">The pkgsrc user's guide</title> 66 <title id="users-guide.title">The pkgsrc user's guide</title>
67 67
 68 &chap.help-user;
68 &chap.getting; 69 &chap.getting;
69 &chap.platform; 70 &chap.platform;
70 &chap.using; 71 &chap.using;
71 &chap.configuring; 72 &chap.configuring;
72 &chap.binary; 73 &chap.binary;
73 &chap.bulk; 74 &chap.bulk;
74 &chap.files; 75 &chap.files;
75 &chap.faq; 76 &chap.faq;
76 </part> 77 </part>
77 78
78 <!-- "part II" (we need to rid the documentation of this reference) --> 79 <!-- "part II" (we need to rid the documentation of this reference) -->
79 <part id="developers-guide"> <?dbhtml filename="developers-guide.html"?> 80 <part id="developers-guide"> <?dbhtml filename="developers-guide.html"?>
80 <title id="developers-guide.title">The pkgsrc developer's guide</title> 81 <title id="developers-guide.title">The pkgsrc developer's guide</title>
81 82
82 <partintro><para>This part of the book deals with creating and 83 <partintro><para>This part of the book deals with creating and
83 modifying packages. It starts with a <quote>HOWTO</quote>-like 84 modifying packages. It starts with a <quote>HOWTO</quote>-like
84 guide on creating a new package. The remaining chapters are more 85 guide on creating a new package. The remaining chapters are more
85 like a reference manual for pkgsrc.</para></partintro> 86 like a reference manual for pkgsrc.</para></partintro>
86 87
 88 &chap.help-devel;
87 &chap.creating; 89 &chap.creating;
88 &chap.components; 90 &chap.components;
89 &chap.makefile; 91 &chap.makefile;
90 &chap.plist; 92 &chap.plist;
91 &chap.buildlink; 93 &chap.buildlink;
92 &chap.pkginstall; 94 &chap.pkginstall;
93 &chap.options; 95 &chap.options;
94 &chap.build; 96 &chap.build;
95 &chap.tools; 97 &chap.tools;
96 &chap.fixes; 98 &chap.fixes;
97 &chap.debug; 99 &chap.debug;
98 &chap.submit; 100 &chap.submit;
99 &chap.devfaq; 101 &chap.devfaq;