pkgsrc-Changes-HG archive

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

[pkgsrc/trunk]: pkgsrc/doc/guide/files Various fixes for typos and grammar by...



details:   https://anonhg.NetBSD.org/pkgsrc/rev/ac8351393ea4
branches:  trunk
changeset: 498767:ac8351393ea4
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Fri Sep 02 19:12:37 2005 +0000

description:
Various fixes for typos and grammar by Leonard Schmidt.

diffstat:

 doc/guide/files/binary.xml       |  20 ++++++++++----------
 doc/guide/files/build.xml        |  32 ++++++++++++++++----------------
 doc/guide/files/buildlink.xml    |  14 +++++++-------
 doc/guide/files/components.xml   |  16 ++++++++--------
 doc/guide/files/configuring.xml  |   8 ++++----
 doc/guide/files/editing.xml      |   6 +++---
 doc/guide/files/examples.xml     |   4 ++--
 doc/guide/files/faq.xml          |  21 ++++++++-------------
 doc/guide/files/fixes.xml        |  34 +++++++++++++++++-----------------
 doc/guide/files/introduction.xml |   6 +++---
 doc/guide/files/makefile.xml     |  22 +++++++++++-----------
 doc/guide/files/options.xml      |   4 ++--
 doc/guide/files/pkginstall.xml   |  17 ++++++++---------
 doc/guide/files/platforms.xml    |  20 ++++++++++----------
 doc/guide/files/plist.xml        |  18 +++++++++---------
 doc/guide/files/using.xml        |  24 ++++++++++++------------
 16 files changed, 130 insertions(+), 136 deletions(-)

diffs (truncated from 1032 to 300 lines):

diff -r 2b34a33d5d71 -r ac8351393ea4 doc/guide/files/binary.xml
--- a/doc/guide/files/binary.xml        Fri Sep 02 18:33:14 2005 +0000
+++ b/doc/guide/files/binary.xml        Fri Sep 02 19:12:37 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.14 2005/07/27 21:29:50 rpaulo Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.15 2005/09/02 19:12:37 rillig Exp $ -->
 
 <chapter id="binary">
   <title>Creating binary packages</title>
@@ -9,7 +9,7 @@
     <para>
       Once you have built and installed a package, you can create a
       <emphasis>binary package</emphasis> which can be installed on
-      another system with &man.pkg.add.1; This saves having to build
+      another system with &man.pkg.add.1;. This saves having to build
       the same package on a group of hosts and wasting CPU time. It
       also provides a simple means for others to install your package,
       should you distribute it.
@@ -99,7 +99,7 @@
        <title><filename>pre-build.local</filename></title>
 
        <para>It is possible to configure the bulk build to perform
-         certain site specific tasks at the end of the pre-build
+         certain site-specific tasks at the end of the pre-build
          stage.  If the file 
          <filename>pre-build.local</filename> exists in
          <filename>/usr/pkgsrc/mk/bulk</filename>, it will be executed
@@ -269,7 +269,7 @@
     </sect2>
 
     <sect2 id="setting-up-a-sandbox">
-      <title>Setting up a sandbox for chroot'ed builds</title>
+      <title>Setting up a sandbox for chrooted builds</title>
 
       <para>
         If you don't want all the packages nuked from a machine
@@ -393,7 +393,7 @@
        </step>
       </procedure>
 
-      <para>When the chroot sandbox is setup, you can start
+      <para>When the chroot sandbox is set up, you can start
        the build with the following steps:</para>
 
       <screen>&rprompt; <userinput>cd /usr/sandbox/usr/pkgsrc</userinput>
@@ -413,7 +413,7 @@
       <para> In addition to building a complete set of all packages in
         pkgsrc, the <filename>pkgsrc/mk/bulk/build</filename> script
         may be used to build a subset of the packages contained in
-        pkgsrc.  By setting defining <varname>SPECIFIC_PKGS</varname>
+        pkgsrc.  By setting <varname>SPECIFIC_PKGS</varname>
         in <filename>/etc/mk.conf</filename>, the variables</para>
 
       <itemizedlist>
@@ -468,7 +468,7 @@
       <screen>RSYNC_DST=$CVS_USER%ftp.NetBSD.org@localhost:/pub/NetBSD/packages/pkgsrc-200xQy/NetBSD-a.b.c/arch/upload </screen>
 
       <para>
-        Please use appropviate values for "pkgsrc-200xQy",
+        Please use appropriate values for "pkgsrc-200xQy",
         "NetBSD-a.b.c" and "arch" here. If your login on
         ftp.NetBSD.org is different from <varname>CVS_USER</varname>,
         write your login directly into the variable, e.g. my local
@@ -494,7 +494,7 @@
 
       <para>
         Before uploading the binary pkgs, ssh authentication needs to
-        be set up. This example shows how to setup temporary keys
+        be set up. This example shows how to set up temporary keys
         for the root account <emphasis>inside the sandbox</emphasis>
         (assuming that no keys should be present there usually):
       </para>
@@ -569,7 +569,7 @@
       <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 
+      way that keeps all the dependencies for a given package on the same 
       CD as that package.
     </para>
 
@@ -578,7 +578,7 @@
 
       <para>
         Complete documentation for cdpack is found in the cdpack(1)
-        manpage. The following short example assumes that the binary
+        man page. The following short example assumes that the binary
         packages are left in
         <filename>/usr/pkgsrc/packages/All</filename> and that
         sufficient disk space exists in <filename>/u2</filename> to
diff -r 2b34a33d5d71 -r ac8351393ea4 doc/guide/files/build.xml
--- a/doc/guide/files/build.xml Fri Sep 02 18:33:14 2005 +0000
+++ b/doc/guide/files/build.xml Fri Sep 02 19:12:37 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.9 2005/07/27 21:29:50 rpaulo Exp $ -->
+<!-- $NetBSD: build.xml,v 1.10 2005/09/02 19:12:37 rillig Exp $ -->
 
 <chapter id="build">
   <title>The build process</title>
@@ -55,8 +55,8 @@
       </listitem>
 
       <listitem>
-       <para>X11 based are special in that they may be installed in either
-         <varname>X11BASE</varname> or <varname>LOCALBASE</varname>.</para>
+       <para>X11-based packages are special in that they may be installed in
+         either <varname>X11BASE</varname> or <varname>LOCALBASE</varname>.</para>
 
        <para>Usually, X11 packages should be installed under
          <varname>LOCALBASE</varname> whenever possible.  Note that you will
@@ -202,8 +202,8 @@
            <filename>.shar.Z</filename>, <filename>.shar</filename>,
            <filename>.Z</filename>, <filename>.bz2</filename> and
            <filename>.gz</filename>; see the definition of the
-           various <varname>DECOMPRESS_CMD</varname> variables
-           <filename>bsd.pkg.mk</filename> for a complete
+           various <varname>DECOMPRESS_CMD</varname> variables in
+           <filename>bsd.pkg.extract.mk</filename> for a complete
            list). Here's an example on how to use the other variables
            for a program that comes with a compressed shell archive
            whose name ends in <filename>.msg.gz</filename>:</para>
@@ -409,7 +409,7 @@
            updating in case a previous <command>make update</command> was interrupted
            for some reason.  However, in this case, make sure you don't call
            <command>make clean</command> or otherwise remove the list of dependent
-           packages in <varname>WRKDIR</varname>.  Otherwise you lose the
+           packages in <varname>WRKDIR</varname>.  Otherwise, you lose the
            ability to automatically update the current package along with the
            dependent packages you have installed.</para>
 
@@ -489,10 +489,10 @@
            <command>make update</command> and only if you have a dirty package tree
            (e.g., if you used <varname>NOCLEAN</varname>).</para>
 
-         <para>If you unsure about whether your tree is clean you can either perform
-           a <command>make clean</command> at the top of the tree, or use the
-           following sequence of commands from the directory of the package you
-           want to update (<emphasis>before</emphasis> running
+         <para>If you are unsure about whether your tree is clean, you can either
+           perform a <command>make clean</command> at the top of the tree, or use
+           the following sequence of commands from the directory of the package
+           you want to update (<emphasis>before</emphasis> running
            <command>make update</command> for the first time, otherwise you lose
            all the packages you wanted to update!):</para>
 
@@ -669,10 +669,10 @@
        <listitem>
          <para>Used to do bulk builds. If an appropriate binary package already exists,
            no action is taken. If not, this target will compile, install and
-           package it (and it's depends, if <varname>PKG_DEPENDS</varname> is
-           set properly. See <xref linkend="binary.configuration"/>.
+           package it (and its depends, if <varname>PKG_DEPENDS</varname> is
+           set properly. See <xref linkend="binary.configuration"/>).
            After creating the binary
-           package, the sources, the just-installed package and it's required
+           package, the sources, the just-installed package and its required
            packages are removed, preserving free disk space.</para>
 
          <para><emphasis>Beware that this target may deinstall all
@@ -685,11 +685,11 @@
 
        <listitem>
          <para>Used during bulk-installs to install required packages. If an
-           upto-date binary package is available, it will be installed via
+           up-to-date binary package is available, it will be installed via
            &man.pkg.add.1;. If not, <command>make bulk-package</command> will be executed,
-           but the installed binary not be removed. </para>
+           but the installed binary won't be removed. </para>
 
-         <para> A binary package is considered <quote>upto-date</quote> to be
+         <para> A binary package is considered <quote>up-to-date</quote> to be
            installed via &man.pkg.add.1; if:</para>
 
          <itemizedlist>
diff -r 2b34a33d5d71 -r ac8351393ea4 doc/guide/files/buildlink.xml
--- a/doc/guide/files/buildlink.xml     Fri Sep 02 18:33:14 2005 +0000
+++ b/doc/guide/files/buildlink.xml     Fri Sep 02 19:12:37 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: buildlink.xml,v 1.6 2005/07/27 21:29:50 rpaulo Exp $ -->
+<!-- $NetBSD: buildlink.xml,v 1.7 2005/09/02 19:12:37 rillig Exp $ -->
 
 <chapter id="buildlink">
   <title>Buildlink methodology</title>
@@ -88,7 +88,7 @@
       </listitem>
 
       <listitem>
-       <para><filename>curses.buildlink3.mk</filename> If the system
+       <para><filename>curses.buildlink3.mk</filename>: If the system
           comes with neither Curses nor NCurses, this will take care
          to install the <filename 
            role="pkg">devel/ncurses</filename> package.</para>  
@@ -106,13 +106,13 @@
          for a system-provided
          Motif installation or adds a dependency on <filename 
            role="pkg">x11/lesstif</filename> or
-         <filename role="pkg">x11/openmotif</filename>;</para>
+         <filename role="pkg">x11/openmotif</filename>.</para>
       </listitem>
 
       <listitem>
        <para><filename>ossaudio.buildlink3.mk</filename> defines several
          variables that may be used by packages that use the
-         Open Sound System (OSS) API;</para>
+         Open Sound System (OSS) API.</para>
       </listitem>
 
       <listitem>
@@ -125,7 +125,7 @@
        <para><filename>pthread.buildlink3.mk</filename> uses the value of
          <varname>PTHREAD_OPTS</varname> and checks for native pthreads or adds
          a dependency on <filename 
-           role="pkg">devel/pth</filename> as needed;</para>
+           role="pkg">devel/pth</filename> as needed.</para>
       </listitem>
 
       <listitem>
@@ -234,7 +234,7 @@
         <listitem>
          <para> <varname>BUILDLINK_PKGSRCDIR.<replaceable>pkg</replaceable></varname>
            is the location of the <replaceable>pkg</replaceable>
-           pkgsrc directory;</para> 
+           pkgsrc directory.</para> 
        </listitem>
        
         <listitem>
@@ -359,7 +359,7 @@
       <orderedlist>
         <listitem>
          <para> if the sonames (major number of the library version)
-           of any installed shared libraries change; </para>
+           of any installed shared libraries change. </para>
         </listitem>
 
         <listitem>
diff -r 2b34a33d5d71 -r ac8351393ea4 doc/guide/files/components.xml
--- a/doc/guide/files/components.xml    Fri Sep 02 18:33:14 2005 +0000
+++ b/doc/guide/files/components.xml    Fri Sep 02 19:12:37 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.12 2005/08/04 17:38:06 gdt Exp $ -->
+<!-- $NetBSD: components.xml,v 1.13 2005/09/02 19:12:37 rillig Exp $ -->
 
 <chapter id="components"> <?dbhtml filename="components.html"?>
   <title>Package components - files, directories and contents</title>
@@ -100,9 +100,9 @@
          <para>If the package has multiple
            <varname>DISTFILES</varname> or multiple
            <varname>PATCHFILES</varname> from different
-           sites, set <varname>SITES_foo</varname> to a list of URI's
+           sites, set <varname>SITES_foo</varname> to a list of URIs
            where file <quote>foo</quote> may be
-           found. <quote>foo</quote> includes the suffix, e.g.</para>
+           found. <quote>foo</quote> includes the suffix, e.g.:</para>
          <programlisting>DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
 DISTFILES+=     foo-file.tar.gz
 SITES_foo-file.tar.gz=http://www.somewhere.com/somehow/ \
@@ -131,7 +131,7 @@
     <para>The second section contains information about separately
       downloaded patches, if any.
       <itemizedlist>
-       <listitem><para><varname>PATCHFILES</varname>
+       <listitem><para><varname>PATCHFILES:</varname>
          Name(s) of additional files that contain distribution patches.
          There is no default. pkgsrc will look for them at
          <varname>PATCH_SITES</varname>.
@@ -187,7 +187,7 @@
 
     <itemizedlist>
       <listitem>
-        <para>Add <varname>MANCOMPRESSED</varname> if manpages are installed in
+        <para>Add <varname>MANCOMPRESSED</varname> if man pages are installed in
           compressed form by the package; see comment in
           <filename>bsd.pkg.mk</filename>.</para>
       </listitem>
@@ -258,7 +258,7 @@
       problems. (To force patches to apply
       with fuzz you can set <varname>PATCH_FUZZ_FACTOR=-F2</varname>).
       Furthermore, do not put changes for more than one file into a single
-      patch-file, as this will make future modifications more difficult.</para>
+      patch file, as this will make future modifications more difficult.</para>
 
     <para>Similar, a file should be patched at most once, not several times by
       several different patches. If a file needs several patches, they should
@@ -300,7 +300,7 @@
       <quote>category/package</quote> structure as pkgsrc, and patches are
       expected to be stored inside these dirs (also known as
       <filename>$LOCALPATCHES/$PKGPATH</filename>). For
-      example if you want to keep a private patch for
+      example, if you want to keep a private patch for
       <filename>pkgsrc/graphics/png</filename>, keep
       it in <filename>$LOCALPATCHES/graphics/png/mypatch</filename>. All
       files in the named directory are expected to be patch files, and
@@ -392,7 +392,7 @@
   <sect1 id="work-dir">
     <title><filename>work*</filename></title>
 
-    <para>When you type <command>make</command> the distribution files are
+    <para>When you type <command>make</command>, the distribution files are
       unpacked into the directory denoted by
       <varname>WRKDIR</varname>. It can be removed by running



Home | Main Index | Thread Index | Old Index