pkgsrc-Changes-HG archive
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index][Old Index]
[pkgsrc/trunk]: pkgsrc/doc/guide/files Replace <pkg> by <filename role="pkg">...
details: https://anonhg.NetBSD.org/pkgsrc/rev/e9309060d8b5
branches: trunk
changeset: 497435:e9309060d8b5
user: rpaulo <rpaulo%pkgsrc.org@localhost>
date: Wed Jul 27 21:29:50 2005 +0000
description:
Replace <pkg> by <filename role="pkg"> as discussed on netbsd-docs@.
ok hubertf@
diffstat:
doc/guide/files/binary.xml | 26 ++++---
doc/guide/files/build.xml | 13 ++-
doc/guide/files/buildlink.xml | 16 +++-
doc/guide/files/components.xml | 25 ++++---
doc/guide/files/debug.xml | 12 ++-
doc/guide/files/examples.xml | 5 +-
doc/guide/files/faq.xml | 122 +++++++++++++++++++++-----------------
doc/guide/files/fixes.xml | 58 ++++++++++-------
doc/guide/files/introduction.xml | 14 ++-
doc/guide/files/makefile.xml | 4 +-
doc/guide/files/pkginstall.xml | 11 +-
doc/guide/files/platforms.xml | 5 +-
doc/guide/files/plist.xml | 7 +-
doc/guide/files/using.xml | 8 +-
14 files changed, 185 insertions(+), 141 deletions(-)
diffs (truncated from 834 to 300 lines):
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/binary.xml
--- a/doc/guide/files/binary.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/binary.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.13 2005/05/24 12:14:42 wiz Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.14 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="binary">
<title>Creating binary packages</title>
@@ -31,7 +31,8 @@
it. Binary packages are created by default in
<filename>/usr/pkgsrc/packages</filename>, in the form of a
gzipped tar file. See <xref linkend="logs.package"/> for a
- continuation of the above <pkg>misc/figlet</pkg> example.</para>
+ continuation of the above <filename
+ role="pkg">misc/figlet</filename> example.</para>
<para>
See <xref linkend="submit"/> for information on how to submit
@@ -316,7 +317,8 @@
</step>
<step>
- <para><filename>/etc/resolv.conf</filename> (for <pkg>security/smtpd</pkg> and mail):</para>
+ <para><filename>/etc/resolv.conf</filename> (for <filename
+ role="pkg">security/smtpd</filename> and mail):</para>
<screen>&rprompt; <userinput>cp /etc/resolv.conf /usr/sandbox/etc</userinput></screen>
</step>
@@ -328,14 +330,16 @@
</step>
<step>
- <para><filename>/etc/localtime</filename> (for <pkg>security/smtpd</pkg>):</para>
+ <para><filename>/etc/localtime</filename> (for <filename
+ role="pkg">security/smtpd</filename>):</para>
<screen>&rprompt; <userinput>ln -sf /usr/share/zoneinfo/UTC /usr/sandbox/etc/localtime</userinput></screen>
</step>
<step>
- <para><filename>/usr/src</filename> (system sources, for <pkg>sysutils/aperture</pkg>,
- <pkg>net/ppp-mppe</pkg>):</para>
+ <para><filename>/usr/src</filename> (system sources, for <filename
+ role="pkg">sysutils/aperture</filename>,
+ <filename role="pkg">net/ppp-mppe</filename>):</para>
<screen>&rprompt; <userinput>ln -s ../disk1/cvs .</userinput>
&rprompt; <userinput>ln -s cvs/src-2.0 src</userinput></screen>
@@ -562,11 +566,11 @@
After your pkgsrc bulk-build has completed, you may wish to
create a CD-ROM set of the resulting binary packages to assist
in installing packages on other machines. The
- <pkg>pkgtools/cdpack</pkg> package provides a simple tool for
- creating the ISO 9660 images. <command>cdpack</command> arranges
- the packages on the CD-ROMs in a way that keeps all the
- dependencies for given package on the same CD as that
- package.
+ <filename role="pkg">pkgtools/cdpack</filename> package provides
+ a simple tool for creating the ISO 9660 images.
+ <command>cdpack</command> arranges the packages on the CD-ROMs in a
+ way that keeps all the dependencies for given package on the same
+ CD as that package.
</para>
<sect2 id="cdpack-example">
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/build.xml
--- a/doc/guide/files/build.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/build.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.8 2005/06/01 20:58:16 wiz Exp $ -->
+<!-- $NetBSD: build.xml,v 1.9 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="build">
<title>The build process</title>
@@ -78,7 +78,8 @@
<emphasis>both</emphasis> <filename>${X11BASE}</filename> and
<filename>${LOCALBASE}</filename>. To force installation of
all X11 packages in <varname>LOCALBASE</varname>, the
- <pkg>pkgtools/xpkgwedge</pkg> package is enabled by default.</para>
+ <filename role="pkg">pkgtools/xpkgwedge</filename> package
+ is enabled by default.</para>
</listitem>
<listitem>
@@ -258,7 +259,7 @@
configure script's name can be set in
<varname>CONFIGURE_SCRIPT</varname> if it differs from the
default <quote>configure</quote>. Here's an example from
- the <pkg>sysutils/top</pkg> package:</para>
+ the <filename role="pkg">sysutils/top</filename> package:</para>
<programlisting>HAS_CONFIGURE= yes
CONFIGURE_SCRIPT= Configure
@@ -535,8 +536,10 @@
<listitem>
<para>This target generates a <filename>README.html</filename> file, which
- can be viewed using a browser such as <pkg>www/mozilla</pkg> or
- <pkg>www/links</pkg>. The generated files contain references to any
+ can be viewed using a browser such as
+ <filename role="pkg">www/mozilla</filename> or
+ <filename role="pkg">www/links</filename>.
+ The generated files contain references to any
packages which are in the <varname>PACKAGES</varname> directory on
the local host. The generated files can be made to refer to URLs based on
<varname>FTP_PKG_URL_HOST</varname> and
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/buildlink.xml
--- a/doc/guide/files/buildlink.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/buildlink.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: buildlink.xml,v 1.5 2005/06/03 16:05:30 reed Exp $ -->
+<!-- $NetBSD: buildlink.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="buildlink">
<title>Buildlink methodology</title>
@@ -90,7 +90,8 @@
<listitem>
<para><filename>curses.buildlink3.mk</filename> If the system
comes with neither Curses nor NCurses, this will take care
- to install the <pkg>devel/ncurses</pkg> package.</para>
+ to install the <filename
+ role="pkg">devel/ncurses</filename> package.</para>
</listitem>
<listitem>
@@ -103,8 +104,9 @@
<listitem>
<para><filename>motif.buildlink3.mk</filename> checks
for a system-provided
- Motif installation or adds a dependency on <pkg>x11/lesstif</pkg> or
- <pkg>x11/openmotif</pkg>;</para>
+ Motif installation or adds a dependency on <filename
+ role="pkg">x11/lesstif</filename> or
+ <filename role="pkg">x11/openmotif</filename>;</para>
</listitem>
<listitem>
@@ -122,7 +124,8 @@
<listitem>
<para><filename>pthread.buildlink3.mk</filename> uses the value of
<varname>PTHREAD_OPTS</varname> and checks for native pthreads or adds
- a dependency on <pkg>devel/pth</pkg> as needed;</para>
+ a dependency on <filename
+ role="pkg">devel/pth</filename> as needed;</para>
</listitem>
<listitem>
@@ -150,7 +153,8 @@
headers and libraries that it needs in turn.</para>
<para> To generate an initial <filename>buildlink3.mk</filename>
- file for further editing, Rene Hexel's <pkg>pkgtools/createbuildlink</pkg>
+ file for further editing, Rene Hexel's <filename
+ role="pkg">pkgtools/createbuildlink</filename>
package is highly recommended. For most packages, the following
command will generate a good starting point for
<filename>buildlink3.mk</filename> files:</para>
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/components.xml
--- a/doc/guide/files/components.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/components.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.8 2005/05/24 12:14:42 wiz Exp $ -->
+<!-- $NetBSD: components.xml,v 1.9 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="components"> <?dbhtml filename="components.html"?>
<title>Package components - files, directories and contents</title>
@@ -187,15 +187,17 @@
The digest algorithm used was, at one stage, md5, but that was felt
lacking compared to sha1, and so sha1 is now the default algorithm.
The distfile size is also generated and stored in new distinfo files.
- The <pkg>pkgtools/digest</pkg> utility calculates all of the digests
- in the distinfo file, and it provides various different algorithms.
- At the current time, the algorithms provided are:
+ The <filename role="pkg">pkgtools/digest</filename> utility
+ calculates all of the digests in the distinfo file, and it provides
+ various different algorithms. At the current time, the algorithms
+ provided are:
<emphasis>md5</emphasis>, <emphasis>rmd160</emphasis>,
<emphasis>sha1</emphasis>, <emphasis>sha256</emphasis>,
<emphasis>sha384</emphasis> and <emphasis>sha512</emphasis>.</para>
<para>Some packages have different sets of distfiles on a per architecture
- basis, for example <pkg>www/navigator</pkg>). These are kept in the
+ basis, for example <filename
+ role="pkg">www/navigator</filename>). These are kept in the
same distinfo file and care should be taken when upgrading such a
package to ensure distfile information is not lost.</para>
@@ -236,7 +238,8 @@
get stored in the patch files, as these will cause problems when
later checked into the &os; CVS tree. Use the
<command>pkgdiff</command> from the
- <pkg>pkgtools/pkgdiff</pkg> package to avoid these problems.</para>
+ <filename role="pkg">pkgtools/pkgdiff</filename> package to avoid
+ these problems.</para>
<para>For even more automation, we recommend using <command>mkpatches</command> from the same
package to make a whole set of patches. You just have to backup files
@@ -361,8 +364,8 @@
<para> If a package doesn't create a subdirectory for itself (like
GNU software does, for instance), but extracts itself in the
current directory, you should set <varname>WRKSRC</varname>
- accordingly, e.g. <pkg>editors/sam</pkg> again, but the quick
- answer is: </para>
+ accordingly, e.g. <filename role="pkg">editors/sam</filename>
+ again, but the quick answer is: </para>
<programlisting>WRKSRC= ${WRKDIR}</programlisting>
@@ -371,8 +374,10 @@
package doesn't create a subdir with the name of
<varname>DISTNAME</varname> but some different name, set
<varname>WRKSRC</varname> to point to the proper name in
- <filename>${WRKDIR}</filename>. See <pkg>lang/tcl</pkg> and
- <pkg>x11/tk</pkg> for examples, and here is another one: </para>
+ <filename>${WRKDIR}</filename>. See <filename
+ role="pkg">lang/tcl</filename> and
+ <filename role="pkg">x11/tk</filename> for examples, and here is
+ another one: </para>
<programlisting>WRKSRC= ${WRKDIR}/${DISTNAME}/unix</programlisting>
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/debug.xml
--- a/doc/guide/files/debug.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/debug.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: debug.xml,v 1.1.1.1 2004/10/21 14:27:38 grant Exp $ -->
+<!-- $NetBSD: debug.xml,v 1.2 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="debug">
<title>Debugging</title>
@@ -15,8 +15,8 @@
</listitem>
<listitem>
- <para>Install <pkg>pkgtools/url2pkg</pkg>, create a directory
- for a new package, change into it, then run
+ <para>Install <filename role="pkg">pkgtools/url2pkg</filename>,
+ create a directory for a new package, change into it, then run
<command>url2pkg</command>:</para>
<screen>&cprompt; <userinput>mkdir /usr/pkgsrc/<replaceable>category</replaceable>/<replaceable>examplepkg</replaceable></userinput>
@@ -58,7 +58,8 @@
shouldn't be, especially during the build
phase. <command>mkpatches</command>,
<command>patchdiff</command> and <command>pkgvi</command> are
- from the <pkg>pkgtools/pkgdiff</pkg> package. </para>
+ from the <filename role="pkg">pkgtools/pkgdiff</filename>
+ package. </para>
</listitem>
<listitem>
@@ -116,7 +117,8 @@
</listitem>
<listitem>
- <para>Run <command>pkglint</command> from <pkg>pkgtools/pkglint</pkg>,
+ <para>Run <command>pkglint</command> from
+ <filename role="pkg">pkgtools/pkglint</filename>,
and fix the problems it reports:</para>
<screen>&rprompt; <userinput>pkglint</userinput></screen>
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/examples.xml
--- a/doc/guide/files/examples.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/examples.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: examples.xml,v 1.5 2005/05/24 12:14:42 wiz Exp $ -->
+<!-- $NetBSD: examples.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ -->
<appendix id="examples">
<title>A simple example package: bison</title>
@@ -53,7 +53,8 @@
<sect2 id="checking-package-with-pkglint">
<title>Checking a package with <command>pkglint</command></title>
- <para>The NetBSD package system comes with <pkg>pkgtools/pkglint</pkg>
+ <para>The NetBSD package system comes with
+ <filename role="pkg">pkgtools/pkglint</filename>
which helps to check the contents of these
files. After installation it is quite easy to use, just change to the
directory of the package you wish to examine and execute
diff -r c2ca27b93159 -r e9309060d8b5 doc/guide/files/faq.xml
--- a/doc/guide/files/faq.xml Wed Jul 27 20:26:46 2005 +0000
+++ b/doc/guide/files/faq.xml Wed Jul 27 21:29:50 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: faq.xml,v 1.13 2005/06/03 12:27:48 jmmv Exp $ -->
+<!-- $NetBSD: faq.xml,v 1.14 2005/07/27 21:29:50 rpaulo Exp $ -->
<chapter id="faq"> <?dbhtml filename="faq.html"?>
<title>Frequently Asked Questions</title>
@@ -81,8 +81,8 @@
<itemizedlist>
<listitem>
- <para><pkg>pkgtools/x11-links</pkg>: Symlinks for use by
- buildlink.</para>
+ <para><filename role="pkg">pkgtools/x11-links</filename>:
+ Symlinks for use by buildlink.</para>
</listitem>
Home |
Main Index |
Thread Index |
Old Index