pkgsrc-Changes-HG archive

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

[pkgsrc/trunk]: pkgsrc/doc/guide/files Avoid extra whitespace in <para>.



details:   https://anonhg.NetBSD.org/pkgsrc/rev/f7fc1e1f6519
branches:  trunk
changeset: 518478:f7fc1e1f6519
user:      wiz <wiz%pkgsrc.org@localhost>
date:      Sun Sep 10 19:32:22 2006 +0000

description:
Avoid extra whitespace in <para>.

diffstat:

 doc/guide/files/submit.xml |  71 ++++++++++++++-------------------------------
 doc/guide/files/tools.xml  |  65 ++++++++++++++---------------------------
 doc/guide/files/using.xml  |  33 +++++++++-----------
 3 files changed, 60 insertions(+), 109 deletions(-)

diffs (truncated from 393 to 300 lines):

diff -r a7fdc351876a -r f7fc1e1f6519 doc/guide/files/submit.xml
--- a/doc/guide/files/submit.xml        Sun Sep 10 19:31:42 2006 +0000
+++ b/doc/guide/files/submit.xml        Sun Sep 10 19:32:22 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: submit.xml,v 1.13 2006/09/08 07:38:37 rillig Exp $ -->
+<!-- $NetBSD: submit.xml,v 1.14 2006/09/10 19:32:22 wiz Exp $ -->
 
 <chapter id="submit"> <?dbhtml filename="submit.html"?>
 <title>Submitting and Committing</title>
@@ -87,84 +87,66 @@
 
 <sect1 id="committing-importing">
 <title>Committing: Importing a package into CVS</title>
-<para>
-  This section is only of interest for pkgsrc developers with write
+<para>This section is only of interest for pkgsrc developers with write
   access to the pkgsrc repository. Please remember that cvs
   imports files relative to the current working directory, and that
   the pathname that you
   give the <command>cvs import</command> command is so that it knows where
   to place the files in the repository.  Newly created packages should be
   imported with a vendor tag of <quote>TNF</quote> and a release tag of
-  <quote>pkgsrc-base</quote>, e.g:
-</para>
+  <quote>pkgsrc-base</quote>, e.g:</para>
 
 <programlisting>
     &uprompt; cd .../pkgsrc/category/pkgname
     &uprompt; cvs import pkgsrc/category/pkgname TNF pkgsrc-base
 </programlisting>
 
-<para>
-  Remember to move the directory from which you imported out of
+<para>Remember to move the directory from which you imported out of
   the way, or cvs will complain the next time you <quote>cvs
   update</quote> your source tree.  Also don't forget to add the new
-  package to the category's <filename>Makefile</filename>.
-</para>
+  package to the category's <filename>Makefile</filename>.</para>
 
-<para>
-  The commit message of the initial import should include part of the
+<para>The commit message of the initial import should include part of the
   <filename>DESCR</filename> file, so people reading the mailing lists know
-  what the package is/does.
-</para>
+  what the package is/does.</para>
 
-<para>
-  For new packages, <quote>cvs import</quote> is preferred to <quote>cvs
+<para>For new packages, <quote>cvs import</quote> is preferred to <quote>cvs
   add</quote> because the former gets everything with a single command,
-  and provides a consistent tag.
-</para>
+  and provides a consistent tag.</para>
 </sect1>
 
 <sect1 id="updating-package">
 <title>Updating a package to a newer version</title>
-<para>
-  Please always put a concise, appropriate and relevant summary of the
+<para>Please always put a concise, appropriate and relevant summary of the
   changes between old and new versions into the commit log when updating
-  a package. There are various reasons for this:
-</para>
+  a package. There are various reasons for this:</para>
 
 <itemizedlist>
 <listitem>
-<para>
-  A URL is volatile, and can change over time. It may go away completely
-  or its information may be overwritten by newer information.
-</para>
+<para>A URL is volatile, and can change over time. It may go away completely
+  or its information may be overwritten by newer information.</para>
 </listitem>
 
 <listitem>
-<para>
-  Having the change information between old and new versions in our CVS
-  repository is very useful for people who use either cvs or anoncvs.
-</para>
+<para>Having the change information between old and new versions in our CVS
+  repository is very useful for people who use either cvs or anoncvs.</para>
 </listitem>
 
 <listitem>
-<para>
-  Having the change information between old and new versions in our CVS
+<para>Having the change information between old and new versions in our CVS
   repository is very useful for people who read the pkgsrc-changes mailing
   list, so that they can make tactical decisions about when to upgrade
-  the package.
-</para>
+  the package.</para>
 </listitem>
 </itemizedlist>
 
-<para>
-  Please also recognize that, just because a new version of a package
+<para>Please also recognize that, just because a new version of a package
   has been released, it should not automatically be upgraded in the CVS
   repository.  We prefer to be conservative in the packages that are
   included in pkgsrc - development or beta packages are not really the
   best thing for most places in which pkgsrc is used. Please use your
   judgement about what should go into pkgsrc, and bear in mind that
-  stability is to be preferred above new and possibly untested features.
-</para>
+  stability is to be preferred above new and possibly untested features.</para>
 </sect1>
 
 <sect1 id="moving-package">
@@ -174,13 +156,9 @@
 <listitem><para>Make a copy of the directory somewhere else.</para></listitem>
 
 <listitem><para>Remove all CVS dirs.</para>
-<para>
-  Alternatively to the first two steps you can also do:
-</para>
+<para>Alternatively to the first two steps you can also do:</para>
 <screen><prompt>%</prompt> <userinput>cvs -d user%cvs.NetBSD.org@localhost:/cvsroot export -D today pkgsrc/category/package</userinput></screen>
-<para>
-  and use that for further work.
-</para>
+<para>and use that for further work.</para>
 </listitem>
 
 <listitem><para>Fix <varname>CATEGORIES</varname> and any
@@ -193,8 +171,7 @@
 
 <listitem><para>Check if any package depends on it:
 <screen><prompt>%</prompt> <userinput>cd /usr/pkgsrc</userinput>
-<prompt>%</prompt> <userinput>grep /package */*/Makefile* */*/buildlink*</userinput></screen>
-</para>
+<prompt>%</prompt> <userinput>grep /package */*/Makefile* */*/buildlink*</userinput></screen></para>
 </listitem>
 
 <listitem><para>Fix paths in packages from step 5 to point to new location.</para></listitem>
@@ -207,9 +184,7 @@
 
 <listitem><para>Commit the changed and removed files:</para>
 <screen><prompt>%</prompt> <userinput>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</userinput></screen>
-<para>
-  (and any packages from step 5, of course).
-</para>
+<para>(and any packages from step 5, of course).</para>
 </listitem>
 </orderedlist>
 
diff -r a7fdc351876a -r f7fc1e1f6519 doc/guide/files/tools.xml
--- a/doc/guide/files/tools.xml Sun Sep 10 19:31:42 2006 +0000
+++ b/doc/guide/files/tools.xml Sun Sep 10 19:32:22 2006 +0000
@@ -1,103 +1,82 @@
-<!-- $NetBSD: tools.xml,v 1.3 2006/05/10 22:43:15 rillig Exp $ -->
+<!-- $NetBSD: tools.xml,v 1.4 2006/09/10 19:32:55 wiz Exp $ -->
 
 <chapter id="tools">
 <title>Tools needed for building or running</title>
 
-<para>
-The <varname>USE_TOOLS</varname> definition is used both internally
+<para>The <varname>USE_TOOLS</varname> definition is used both internally
 by pkgsrc and also for individual packages to define what commands
 are needed for building a package (like <varname>BUILD_DEPENDS</varname>)
 or for later run-time of an installed packaged (such as
 <varname>DEPENDS</varname>).
 If the native system provides an adequate tool, then in many cases, a pkgsrc
-package will not be used.
-</para>
+package will not be used.</para>
 
-<para>
-When building a package, the replacement tools are
+<para>When building a package, the replacement tools are
 made available in a directory (as symlinks or wrapper scripts)
 that is early in the executable search path. Just like the buildlink
-system, this helps with consistent builds.
-</para>
+system, this helps with consistent builds.</para>
 
-<para>
-A tool may be needed to help build a specific package. For example,
-perl, GNU make (gmake) or yacc may be needed.
-</para>
+<para>A tool may be needed to help build a specific package. For example,
+perl, GNU make (gmake) or yacc may be needed.</para>
 
-<para>
-Also a tool may be needed, for example, because the native system's supplied
+<para>Also a tool may be needed, for example, because the native system's supplied
 tool may be inefficient for building a package with pkgsrc.
 For example, a package may need GNU awk, bison (instead of
-yacc) or a better sed.
-</para>
+yacc) or a better sed.</para>
 
-<para>
-The tools used by a package can be listed by running
-<command>make show-tools</command>.
-</para>
+<para>The tools used by a package can be listed by running
+<command>make show-tools</command>.</para>
 
 <sect1 id="pkgsrc-tools">
 <title>Tools for pkgsrc builds</title>
 
-<para>
-The default set of tools used by pkgsrc is defined in
+<para>The default set of tools used by pkgsrc is defined in
 <filename>bsd.pkg.mk</filename>. This includes standard Unix tools,
 such as: <command>cat</command>, <command>awk</command>,
 <command>chmod</command>, <command>test</command>, and so on.
 These can be seen by running:
-<command>make show-var VARNAME=USE_TOOLS</command>.
-</para>
+<command>make show-var VARNAME=USE_TOOLS</command>.</para>
 
-<para>
-If a package needs a specific program to build
+<para>If a package needs a specific program to build
 then the <varname>USE_TOOLS</varname> variable can be used
-to define the tools needed.
-</para>
+to define the tools needed.</para>
 
 </sect1>
 
 <sect1 id="package-tools">
 <title>Tools needed by packages</title>
 
-<para>
-In the following examples, the :pkgsrc means to use the pkgsrc version
+<para>In the following examples, the :pkgsrc means to use the pkgsrc version
 and not the native version for a build dependency.
 And the :run means that it is used for a
 run-time dependencies also (and becomes a DEPENDS).
 The default is a build dependency which can be set with
 :build. (So in this example, it is the same as gmake:build
-and pkg-config:build.)
-</para>
+and pkg-config:build.)</para>
 
 <programlisting>
 USE_TOOLS+=     mktemp:pkgsrc
 USE_TOOLS+=     gmake perl:run pkg-config
 </programlisting>
 
-<para>
-When using the tools framework, a
+<para>When using the tools framework, a
 <varname>TOOLS_PATH.foo</varname> variable is defined
 which contains the full path to the appropriate tool. For example,
 <varname>TOOLS_PATH.bash</varname> could be <quote>/bin/bash</quote>
-on Linux systems.
-</para>
+on Linux systems.</para>
 
-<para>
-If you always need a pkgsrc version of the
+<para>If you always need a pkgsrc version of the
 tool at run-time, then just use <varname>DEPENDS</varname> instead.
 <!-- jlam said: This is not to
 say that we can't extend the tools framework to do that, but it hasn't been
 something that's come up frequently enough to make it worthwhile to do.
--->
-</para>
+--></para>
 
 </sect1>
 <sect1 id="platform-tools">
 <title>Tools provided by platforms</title>
 
-<para>
-When improving or porting pkgsrc to a new platform, have a look
+<para>When improving or porting pkgsrc to a new platform, have a look
 at (or create) the corresponding platform specific make file fragment under
 <filename>pkgsrc/mk/tools/tools.${OPSYS}.mk</filename> which defines
 the name of the common tools. For example:</para>
diff -r a7fdc351876a -r f7fc1e1f6519 doc/guide/files/using.xml
--- a/doc/guide/files/using.xml Sun Sep 10 19:31:42 2006 +0000
+++ b/doc/guide/files/using.xml Sun Sep 10 19:32:22 2006 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: using.xml,v 1.24 2006/09/02 11:26:16 schwarz Exp $ -->
+<!-- $NetBSD: using.xml,v 1.25 2006/09/10 19:33:05 wiz Exp $ -->
 
 <chapter id="using"> <?dbhtml filename="using.html"?>
 <title>Using pkgsrc</title>
@@ -74,22 +74,21 @@
 <sect2 id="installing-binary-packages">
 <title>Installing binary packages</title>
 
-      <para> If you have the files on a CD-ROM or downloaded them to
+      <para>If you have the files on a CD-ROM or downloaded them to
         your hard disk, you can install them with the following command
         (be sure to <command>su</command> to root first):</para>
 
         <screen><prompt>#</prompt> <userinput>pkg_add /path/to/package.tgz</userinput></screen>
 
-      <para> If you have FTP access and you don't want to download the
+      <para>If you have FTP access and you don't want to download the



Home | Main Index | Thread Index | Old Index