pkgsrc-Changes-HG archive

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

[pkgsrc/trunk]: pkgsrc/doc/guide/files Reindented all <programlisting>s.



details:   https://anonhg.NetBSD.org/pkgsrc/rev/f6dc7611b874
branches:  trunk
changeset: 501445:f6dc7611b874
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Sun Oct 23 11:25:58 2005 +0000

description:
Reindented all <programlisting>s.

diffstat:

 doc/guide/files/binary.xml      |   30 ++--
 doc/guide/files/build.xml       |   53 +++++---
 doc/guide/files/buildlink.xml   |  131 ++++++++++++----------
 doc/guide/files/components.xml  |   87 ++++++++------
 doc/guide/files/configuring.xml |   26 ++--
 doc/guide/files/examples.xml    |   46 ++++---
 doc/guide/files/faq.xml         |   38 ++++--
 doc/guide/files/fixes.xml       |  229 +++++++++++++++++++++++++--------------
 doc/guide/files/ftp-layout.xml  |  123 ++++++++++----------
 doc/guide/files/getting.xml     |    6 +-
 doc/guide/files/makefile.xml    |  106 +++++++++---------
 doc/guide/files/options.xml     |   81 +++++++------
 doc/guide/files/pkginstall.xml  |   48 +++++--
 doc/guide/files/platforms.xml   |   62 +++++++---
 doc/guide/files/plist.xml       |   42 ++++---
 doc/guide/files/submit.xml      |    6 +-
 16 files changed, 638 insertions(+), 476 deletions(-)

diffs (truncated from 1917 to 300 lines):

diff -r 0627b8a679bb -r f6dc7611b874 doc/guide/files/binary.xml
--- a/doc/guide/files/binary.xml        Sun Oct 23 06:02:00 2005 +0000
+++ b/doc/guide/files/binary.xml        Sun Oct 23 11:25:58 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.15 2005/09/02 19:12:37 rillig Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.16 2005/10/23 11:25:58 rillig Exp $ -->
 
 <chapter id="binary">
   <title>Creating binary packages</title>
@@ -72,14 +72,16 @@
          As used in this example, <varname>_ACCEPTABLE=yes</varname>
          accepts <emphasis>all</emphasis> licenses.</para>
 
-        <programlisting>PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
-WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
-BSDSRCDIR=      /usr/src
-BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
-OBJHOSTNAME?=   yes               # use work.`hostname`
-FAILOVER_FETCH= yes               # insist on the correct checksum
-PKG_DEVELOPER?= yes
-_ACCEPTABLE=    yes</programlisting>
+<programlisting>
+    PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
+    WRKOBJDIR?=     /usr/tmp/pkgsrc   # build here instead of in pkgsrc
+    BSDSRCDIR=      /usr/src
+    BSDXSRCDIR=     /usr/xsrc         # for x11/xservers
+    OBJHOSTNAME?=   yes               # use work.`hostname`
+    FAILOVER_FETCH= yes               # insist on the correct checksum
+    PKG_DEVELOPER?= yes
+    _ACCEPTABLE=    yes
+</programlisting>
       </sect3>
 
       <sect3 id="build.conf">
@@ -131,10 +133,12 @@
        version of ssh for some reason, be sure to install ssh before
        starting it from <filename>rc.local</filename>:</para>
 
-      <programlisting>( cd /usr/pkgsrc/security/ssh ; make bulk-install )
-if [ -f /usr/pkg/etc/rc.d/sshd ]; then
-    /usr/pkg/etc/rc.d/sshd
-fi</programlisting>
+<programlisting>
+    ( cd /usr/pkgsrc/security/ssh ; make bulk-install )
+    if [ -f /usr/pkg/etc/rc.d/sshd ]; then
+        /usr/pkg/etc/rc.d/sshd
+    fi
+</programlisting>
 
       <para>Not doing so will result in you being not able to log in
        via ssh after the bulk build is finished or if the machine
diff -r 0627b8a679bb -r f6dc7611b874 doc/guide/files/build.xml
--- a/doc/guide/files/build.xml Sun Oct 23 06:02:00 2005 +0000
+++ b/doc/guide/files/build.xml Sun Oct 23 11:25:58 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.10 2005/09/02 19:12:37 rillig Exp $ -->
+<!-- $NetBSD: build.xml,v 1.11 2005/10/23 11:25:58 rillig Exp $ -->
 
 <chapter id="build">
   <title>The build process</title>
@@ -104,15 +104,19 @@
        <para>The following lines are taken from
          <filename>pkgsrc/wm/scwm/Makefile</filename>:</para>
 
-        <programlisting>EVAL_PREFIX+=           GTKDIR=gtk+
-CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE}        \
-                        --with-gtk-prefix="${GTKDIR}"           \
-                        --enable-multibyte</programlisting>
+<programlisting>
+    EVAL_PREFIX+=           GTKDIR=gtk+
+    CONFIGURE_ARGS+=        --with-guile-prefix=${LOCALBASE}        \
+                            --with-gtk-prefix="${GTKDIR}"           \
+                            --enable-multibyte
+</programlisting>
 
        <para>Specific defaults can be defined for the packages evaluated using
          <varname>EVAL_PREFIX</varname>, by using a definition of the form:</para>
 
-        <programlisting>GTKDIR_DEFAULT= ${LOCALBASE}</programlisting>
+<programlisting>
+    GTKDIR_DEFAULT= ${LOCALBASE}
+</programlisting>
 
        <para>where <varname>GTKDIR</varname> corresponds
          to the first definition in
@@ -146,7 +150,9 @@
            are not present, an attempt will be made to fetch them using commands
            of the form:</para>
 
-          <programlisting>${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}</programlisting>
+<programlisting>
+    ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
+</programlisting>
 
          <para>where ${site} varies through several possibilities in turn: first,
            <varname>MASTER_SITE_OVERRIDE</varname> is tried, then the sites
@@ -208,10 +214,12 @@
            for a program that comes with a compressed shell archive
            whose name ends in <filename>.msg.gz</filename>:</para>
 
-          <programlisting>     EXTRACT_SUFX=   .msg.gz
-     EXTRACT_CMD=            zcat
-     EXTRACT_BEFORE_ARGS=
-     EXTRACT_AFTER_ARGS=     |sh</programlisting>
+<programlisting>
+    EXTRACT_SUFX=           .msg.gz
+    EXTRACT_CMD=            zcat
+    EXTRACT_BEFORE_ARGS=
+    EXTRACT_AFTER_ARGS=     |sh
+</programlisting>
        </listitem>
       </varlistentry>
 
@@ -261,9 +269,11 @@
            default <quote>configure</quote>. Here's an example from
            the <filename role="pkg">sysutils/top</filename> package:</para>
 
-          <programlisting>HAS_CONFIGURE=          yes
-CONFIGURE_SCRIPT=       Configure
-CONFIGURE_ARGS+=        netbsd13</programlisting>
+<programlisting>
+    HAS_CONFIGURE=          yes
+    CONFIGURE_SCRIPT=       Configure
+    CONFIGURE_ARGS+=        netbsd13
+</programlisting>
 
          <para>If the program uses an Imakefile for configuration, the appropriate
            steps can be invoked by setting <varname>USE_IMAKE</varname> to
@@ -310,13 +320,14 @@
       If a subsequent stage is requested, all prior stages are made: e.g.
       <command>make build</command> will also perform the equivalent of:</para>
 
-    <programlisting>
-make fetch
-make checksum
-make extract
-make patch
-make configure
-make build</programlisting>
+<programlisting>
+    make fetch
+    make checksum
+    make extract
+    make patch
+    make configure
+    make build
+</programlisting>
   </sect1>
 
   <sect1 id="build.helpful-targets">
diff -r 0627b8a679bb -r f6dc7611b874 doc/guide/files/buildlink.xml
--- a/doc/guide/files/buildlink.xml     Sun Oct 23 06:02:00 2005 +0000
+++ b/doc/guide/files/buildlink.xml     Sun Oct 23 11:25:58 2005 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: buildlink.xml,v 1.10 2005/10/07 09:56:12 rillig Exp $ -->
+<!-- $NetBSD: buildlink.xml,v 1.11 2005/10/23 11:25:58 rillig Exp $ -->
 
 <chapter id="buildlink">
   <title>Buildlink methodology</title>
@@ -69,19 +69,25 @@
     <para> If a dependency on a particular package is required for its libraries and
       headers, then we replace: </para>
       
-    <programlisting>DEPENDS+=   foo>=1.1.0:../../category/foo</programlisting>
+<programlisting>
+    DEPENDS+=   foo>=1.1.0:../../category/foo
+</programlisting>
 
     <para>with</para>
 
-    <programlisting>.include "../../category/foo/buildlink3.mk"</programlisting>
+<programlisting>
+    .include "../../category/foo/buildlink3.mk"
+</programlisting>
 
     <para>The buildlink3.mk files usually define the required dependencies.
     If you need a newer version of the dependency when using buildlink3.mk
     files, then you can define it in your Makefile; for example:
     </para>
 
-    <programlisting>BUILDLINK_DEPENDS.foo+=   foo>=1.1.0
-.include "../../category/foo/buildlink3.mk"</programlisting>
+<programlisting>
+    BUILDLINK_DEPENDS.foo+=   foo>=1.1.0
+    .include "../../category/foo/buildlink3.mk"
+</programlisting>
 
     <para>There are several <filename>buildlink3.mk</filename>
       files in <filename>pkgsrc/mk</filename>
@@ -177,28 +183,29 @@
         <filename>buildlink3.mk</filename> is taken 
         from <filename>pkgsrc/graphics/tiff</filename>:</para>
 
-      <programlisting>
-# &#36;NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp &#36;
+<programlisting>
+    # &#36;NetBSD: buildlink3.mk,v 1.7 2004/03/18 09:12:12 jlam Exp &#36;
 
-BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
-TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
+    BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH}+
+    TIFF_BUILDLINK3_MK:=    ${TIFF_BUILDLINK3_MK}+
 
-.if !empty(BUILDLINK_DEPTH:M+)
-BUILDLINK_DEPENDS+=     tiff
-.endif
+    .if !empty(BUILDLINK_DEPTH:M+)
+    BUILDLINK_DEPENDS+=     tiff
+    .endif
 
-BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
-BUILDLINK_PACKAGES+=    tiff
+    BUILDLINK_PACKAGES:=    ${BUILDLINK_PACKAGES:Ntiff}
+    BUILDLINK_PACKAGES+=    tiff
 
-.if !empty(TIFF_BUILDLINK3_MK:M+)
-BUILDLINK_DEPENDS.tiff+=        tiff>=3.6.1
-BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
-.endif  # TIFF_BUILDLINK3_MK
+    .if !empty(TIFF_BUILDLINK3_MK:M+)
+    BUILDLINK_DEPENDS.tiff+=        tiff>=3.6.1
+    BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
+    .endif  # TIFF_BUILDLINK3_MK
 
-.include "../../devel/zlib/buildlink3.mk"
-.include "../../graphics/jpeg/buildlink3.mk"
+    .include "../../devel/zlib/buildlink3.mk"
+    .include "../../graphics/jpeg/buildlink3.mk"
 
-BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//} </programlisting>
+    BUILDLINK_DEPTH:=       ${BUILDLINK_DEPTH:S/+$//}
+</programlisting>
 
       <para> The header and footer manipulate
         <varname>BUILDLINK_DEPTH</varname>, which is common across all
@@ -447,46 +454,46 @@
       <para>The following is the recommended template for builtin.mk
         files: </para>
 
-      <programlisting>
-.if !defined(IS_BUILTIN.foo)
-#
-# IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
-# genuinely exists in the system or not.
-#
-IS_BUILTIN.foo?=        no
+<programlisting>
+    .if !defined(IS_BUILTIN.foo)
+    #
+    # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
+    # genuinely exists in the system or not.
+    #
+    IS_BUILTIN.foo?=        no
 
-# BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
-# version can be determined.
-#
-.  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
-BUILTIN_PKG.foo?=       foo-1.0
-.  endif
-.endif  # IS_BUILTIN.foo
+    # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
+    # version can be determined.
+    #
+    .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
+    BUILTIN_PKG.foo?=       foo-1.0
+    .  endif
+    .endif  # IS_BUILTIN.foo
 
-.if !defined(USE_BUILTIN.foo)
-USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
-.  if defined(BUILTIN_PKG.foo)
-.    for _depend_ in ${BUILDLINK_DEPENDS.foo}
-.      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
-USE_BUILTIN.foo!=                                                       \
-      if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then     \
-              ${ECHO} "yes";                                            \
-      else                                                              \
-              ${ECHO} "no";                                             \
-      fi
-.      endif
-.    endfor
-.  endif
-.endif  # USE_BUILTIN.foo
+    .if !defined(USE_BUILTIN.foo)
+    USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
+    .  if defined(BUILTIN_PKG.foo)
+    .    for _depend_ in ${BUILDLINK_DEPENDS.foo}
+    .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
+    USE_BUILTIN.foo!=                                                       \
+          if ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}; then     \
+                  ${ECHO} "yes";                                            \
+          else                                                              \
+                  ${ECHO} "no";                                             \
+          fi
+    .      endif
+    .    endfor
+    .  endif
+    .endif  # USE_BUILTIN.foo
 



Home | Main Index | Thread Index | Old Index