pkgsrc-Changes-HG archive

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

[pkgsrc/trunk]: pkgsrc/doc/guide/files Made all references to mk.conf consist...



details:   https://anonhg.NetBSD.org/pkgsrc/rev/0792ba151162
branches:  trunk
changeset: 532266:0792ba151162
user:      rillig <rillig%pkgsrc.org@localhost>
date:      Wed Aug 15 06:33:43 2007 +0000

description:
Made all references to mk.conf consistent by defining and using a macro
for it. Suggested by joerg.

diffstat:

 doc/guide/files/binary.xml      |  13 ++++++-------
 doc/guide/files/build.xml       |  12 +++++-------
 doc/guide/files/components.xml  |   4 ++--
 doc/guide/files/configuring.xml |  14 ++++++++------
 doc/guide/files/debug.xml       |   5 ++---
 doc/guide/files/faq.xml         |  16 ++++++++--------
 doc/guide/files/files.xml       |   4 ++--
 doc/guide/files/fixes.xml       |  10 +++++-----
 doc/guide/files/infr.design.xml |   9 +++------
 doc/guide/files/options.xml     |   6 +++---
 doc/guide/files/pkgsrc.ent      |   7 +++++++
 doc/guide/files/platforms.xml   |  23 +++++++++++------------
 doc/guide/files/submit.xml      |   4 ++--
 doc/guide/files/using.xml       |  12 ++++++------
 14 files changed, 70 insertions(+), 69 deletions(-)

diffs (truncated from 536 to 300 lines):

diff -r d220adf69957 -r 0792ba151162 doc/guide/files/binary.xml
--- a/doc/guide/files/binary.xml        Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/binary.xml        Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: binary.xml,v 1.32 2007/06/01 11:07:24 rillig Exp $ -->
+<!-- $NetBSD: binary.xml,v 1.33 2007/08/15 06:33:43 rillig Exp $ -->
 
 <chapter id="binary">
   <title>Creating binary packages</title>
@@ -75,15 +75,14 @@
       </sect3>
 
       <sect3 id="binary.mk.conf">
-       <title>/etc/mk.conf</title>
+       <title>&mk.conf;</title>
 
-       <para>You may want to set variables in
-       <filename>/etc/mk.conf</filename>.
+       <para>You may want to set variables in &mk.conf;.
        Look at <filename>pkgsrc/mk/defaults/mk.conf</filename> for
        details of the default settings. You will want to ensure that
        <varname>ACCEPTABLE_LICENSES</varname> meet your local policy.
        As used in this example, <varname>_ACCEPTABLE=yes</varname>
-       accepts <emphasis>all</emphasis> licenses.</para>
+       completely bypasses the license check.</para>
 
 <programlisting>
 PACKAGES?=      ${_PKGSRCDIR}/packages/${MACHINE_ARCH}
@@ -425,7 +424,7 @@
        </step>
 
        <step>
-         <para>Edit <filename>/etc/mk.conf</filename>, see <xref linkend="binary.mk.conf"/>.</para>
+         <para>Edit &mk.conf;, see <xref linkend="binary.mk.conf"/>.</para>
        </step>
 
        <step>
@@ -455,7 +454,7 @@
       pkgsrc, the <filename>pkgsrc/mk/bulk/build</filename> script
       may be used to build a subset of the packages contained in
       pkgsrc.  By setting <varname>SPECIFIC_PKGS</varname>
-      in <filename>/etc/mk.conf</filename>, the variables</para>
+      in &mk.conf;, the variables</para>
 
       <itemizedlist>
        <listitem><para>SITE_SPECIFIC_PKGS</para></listitem>
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/build.xml
--- a/doc/guide/files/build.xml Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/build.xml Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: build.xml,v 1.46 2007/06/01 11:07:24 rillig Exp $ -->
+<!-- $NetBSD: build.xml,v 1.47 2007/08/15 06:33:44 rillig Exp $ -->
 
 <chapter id="build">
   <title>The build process</title>
@@ -909,7 +909,7 @@
          fail!</para>
 
          <para>The following variables can be used either on the
-         command line or in <filename>/etc/mk.conf</filename> to
+         command line or in &mk.conf; to
          alter the behaviour of <command>make
          update</command>:</para>
 
@@ -1012,9 +1012,8 @@
          </screen>
 
          <para>The following variables can be used either on the
-         command line or in <filename>/etc/mk.conf</filename> to
-         alter the behaviour of <command>make
-         clean-update</command>:</para>
+         command line or in &mk.conf; to alter the behaviour of
+         <command>make clean-update</command>:</para>
 
          <variablelist>
            <varlistentry>
@@ -1213,8 +1212,7 @@
          <para>After a package is installed, check all its
          binaries and (on ELF platforms) shared libraries to see
          if they find the shared libs they need.  Run by default
-         if <varname>PKG_DEVELOPER</varname> is set in
-         <filename>/etc/mk.conf</filename>.</para>
+         if <varname>PKG_DEVELOPER</varname> is set in &mk.conf;.</para>
        </listitem>
       </varlistentry>
 
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/components.xml
--- a/doc/guide/files/components.xml    Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/components.xml    Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: components.xml,v 1.36 2007/06/15 10:26:53 rillig Exp $ -->
+<!-- $NetBSD: components.xml,v 1.37 2007/08/15 06:33:44 rillig Exp $ -->
 
 <chapter id="components"> <?dbhtml filename="components.html"?>
 <title>Package components - files, directories and contents</title>
@@ -145,7 +145,7 @@
       other variables handle common cases of setting
       <varname>WRKDIR_BASENAME</varname> individually. If
       <varname>OBJHOSTNAME</varname> is defined in
-      <filename>/etc/mk.conf</filename>, the first component of
+      &mk.conf;, the first component of
       the host's name is attached to the directory name. If
       <varname>OBJMACHINE</varname> is defined, the platform name
       is attached, which might look like
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/configuring.xml
--- a/doc/guide/files/configuring.xml   Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/configuring.xml   Wed Aug 15 06:33:43 2007 +0000
@@ -1,8 +1,10 @@
-<!-- $NetBSD: configuring.xml,v 1.28 2007/08/10 00:51:51 wiz Exp $ -->
+<!-- $NetBSD: configuring.xml,v 1.29 2007/08/15 06:33:44 rillig Exp $ -->
 
 <chapter id="configuring">
   <title>Configuring pkgsrc</title>
 
+<anchor id="mk.conf" />
+
 <para>The whole pkgsrc system is configured in a single file, usually
 called <filename>mk.conf</filename>. In which directory pkgsrc looks for
 that file depends on the installation. On NetBSD, when you use
@@ -111,7 +113,7 @@
            information.</para>
        </listitem>
        <listitem><para><varname>PKGMAKECONF</varname>: Location of
-           the <filename>mk.conf</filename> file used by a package's
+           the &mk.conf; file used by a package's
            BSD-style Makefile. If this is not set,
            <varname>MAKECONF</varname> is set to
            <filename>/dev/null</filename> to avoid picking up
@@ -343,7 +345,7 @@
 </programlisting>
 
     <para>The following variables can be defined in
-    <filename>/etc/mk.conf</filename> to select which options to
+    &mk.conf; to select which options to
     enable for a package: <varname>PKG_DEFAULT_OPTIONS</varname>,
     which can be used to select or disable options for all packages
     that support them, and
@@ -354,7 +356,7 @@
     are disabled. A few examples:</para>
 
     <screen>
-&uprompt; <command>grep "PKG.*OPTION" /etc/mk.conf</command>
+&uprompt; <command>grep "PKG.*OPTION" &mk.conf;</command>
 PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
 PKG_OPTIONS.kdebase=    debug -sasl
 PKG_OPTIONS.apache=     suexec </screen>
@@ -385,12 +387,12 @@
     <para>Before the options framework was introduced, build options
     were selected by setting a variable (often named
     <varname>USE_<replaceable>FOO</replaceable></varname>) in
-    <filename>/etc/mk.conf</filename> for each option.  To ease
+    &mk.conf; for each option.  To ease
     transition to the options framework for the user, these legacy
     variables are converted to the appropriate options setting
     (<varname>PKG_OPTIONS.<replaceable>pkgbase</replaceable></varname>)
     automatically.  A warning is issued to prompt the user to update
-    <filename>/etc/mk.conf</filename> to use the options framework
+    &mk.conf; to use the options framework
     directly.  Support for the legacy variables will be removed
     eventually.</para>
   </sect1>
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/debug.xml
--- a/doc/guide/files/debug.xml Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/debug.xml Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: debug.xml,v 1.6 2006/12/03 01:03:38 kano Exp $ -->
+<!-- $NetBSD: debug.xml,v 1.7 2007/08/15 06:33:44 rillig Exp $ -->
 
 <chapter id="debug">
   <title>Debugging</title>
@@ -10,8 +10,7 @@
 
   <itemizedlist>
     <listitem>
-      <para>Be sure to set <varname>PKG_DEVELOPER=1</varname> in
-      <filename>/etc/mk.conf</filename></para>
+      <para>Be sure to set <varname>PKG_DEVELOPER=yes</varname> in &mk.conf;.</para>
     </listitem>
 
     <listitem>
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/faq.xml
--- a/doc/guide/files/faq.xml   Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/faq.xml   Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: faq.xml,v 1.36 2007/07/30 21:13:00 kano Exp $ -->
+<!-- $NetBSD: faq.xml,v 1.37 2007/08/15 06:33:44 rillig Exp $ -->
 
 <chapter id="faq"> <?dbhtml filename="faq.html"?>
 <title>Frequently Asked Questions</title>
@@ -264,7 +264,7 @@
 <para>By default, resuming transfers in pkgsrc is disabled, but you can
 enable this feature by adding the option
 <varname>PKG_RESUME_TRANSFERS=YES</varname> into
-<filename>/etc/mk.conf</filename>.  If, during a fetch step, an incomplete
+&mk.conf;.  If, during a fetch step, an incomplete
 distfile is found, pkgsrc will try to resume it.</para>
 
 <para>You can also
@@ -295,7 +295,7 @@
 <para>If you want to use modular X.org from pkgsrc instead of your system's own X11
 (<filename>/usr/X11R6</filename>, <filename>/usr/openwin</filename>, ...)
 you will have to add the following line into
-<filename>/etc/mk.conf</filename>:</para>
+&mk.conf;:</para>
 
 <programlisting>
 X11_TYPE=modular
@@ -348,7 +348,7 @@
 <filename>/usr/bin/ftp</filename>, which automatically tries passive
 connections first, and falls back to active connections if the server
 refuses to do passive.  For the other tools, add the following to your
-<filename>/etc/mk.conf</filename> file:
+&mk.conf; file:
 <varname>PASSIVE_FETCH=1</varname>.</para>
 
 <para>Having that option present will prevent
@@ -420,7 +420,7 @@
 <para>In the case of the <filename
   role="pkg">pkgtools/pkg_install</filename> package, you
 can get away with setting <varname>NOMAN=YES</varname> either in the
-environment or in <filename>/etc/mk.conf</filename>.</para>
+environment or in &mk.conf;.</para>
 
 </sect1>
 
@@ -453,7 +453,7 @@
 package can be used, which does password caching over a limited time.  To
 use it, install sudo (either as binary package or from
 <filename role="pkg">security/sudo</filename>) and then put the
-following into your <filename>/etc/mk.conf</filename>, somewhere
+following into your &mk.conf;, somewhere
 <emphasis>after</emphasis> the definition of the
 <varname>LOCALBASE</varname> variable:</para>
 
@@ -479,7 +479,7 @@
 
 <para>In order to change the defaults, you can modify the
 <varname>PKG_SYSCONFBASE</varname> variable (in
-<filename>/etc/mk.conf</filename>) to point to your preferred configuration
+&mk.conf;) to point to your preferred configuration
 directory; some common examples include <filename>/etc</filename> or
 <filename>/etc/pkg</filename>.</para>
 
@@ -549,7 +549,7 @@
 
        <para>When you add your own preferences to the
        <varname>CFLAGS</varname> variable in your
-       <filename>mk.conf</filename>, these flags are passed in
+       &mk.conf;, these flags are passed in
        environment variables to the <filename>./configure</filename>
        scripts and to &man.make.1;. Some package authors ignore the
        <varname>CFLAGS</varname> from the environment variable by
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/files.xml
--- a/doc/guide/files/files.xml Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/files.xml Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: files.xml,v 1.5 2007/06/01 11:07:25 rillig Exp $ -->
+<!-- $NetBSD: files.xml,v 1.6 2007/08/15 06:33:45 rillig Exp $ -->
 
 <chapter id="files">
 <title>Directory layout of the installed files</title>
@@ -53,7 +53,7 @@
 
 <listitem><para><varname>PKG_SYSCONFDIR</varname> corresponds to
 <filename>/etc</filename> in the base system. It contains configuration
-files of the packages, as well as pkgsrc's <filename>mk.conf</filename>
+files of the packages, as well as pkgsrc's &mk.conf;
 itself.</para></listitem>
 
 </itemizedlist>
diff -r d220adf69957 -r 0792ba151162 doc/guide/files/fixes.xml
--- a/doc/guide/files/fixes.xml Wed Aug 15 06:32:38 2007 +0000
+++ b/doc/guide/files/fixes.xml Wed Aug 15 06:33:43 2007 +0000
@@ -1,4 +1,4 @@
-<!-- $NetBSD: fixes.xml,v 1.88 2007/08/10 00:51:51 wiz Exp $ -->
+<!-- $NetBSD: fixes.xml,v 1.89 2007/08/15 06:33:45 rillig Exp $ -->
 
 <chapter id="fixes"> <?dbhtml filename="fixes.html"?>
 <title>Making your package work</title>
@@ -17,11 +17,11 @@
   </sect2>
 
   <sect2 id="pulling-vars-from-etc-mk.conf">
-    <title>How to pull in user-settable variables from <filename>mk.conf</filename></title>
+    <title>How to pull in user-settable variables from &mk.conf;</title>
 
     <para>The pkgsrc user can configure pkgsrc by overriding several
     variables in the file pointed to by <varname>MAKECONF</varname>,
-    which is <filename>/etc/mk.conf</filename> by default. When you
+    which is &mk.conf; by default. When you
     want to use those variables in the preprocessor directives of
     &man.make.1; (for example <literal>.if</literal> or
     <literal>.for</literal>), you need to include the file
@@ -165,7 +165,7 @@
 
     <para>The license can be viewed with <command>make
     show-license</command>, and if the user so chooses, the line
-    printed above can be added to <filename>/etc/mk.conf</filename> to
+    printed above can be added to &mk.conf; to
     convey to pkgsrc that it should not in the future fail because of



Home | Main Index | Thread Index | Old Index