[pkgsrc/trunk]: pkgsrc/mk/emulator Better formatting for the package- and use...

[jlam <jlam%pkgsrc.org@localhost>]

details:   https://anonhg.NetBSD.org/pkgsrc/rev/dc1a18b3e994
branches:  trunk
changeset: 531375:dc1a18b3e994
user:      jlam <jlam%pkgsrc.org@localhost>
date:      Sun Jul 29 09:24:33 2007 +0000

description:
Better formatting for the package- and user-settable variables, and
document the emul-* helper targets.

diffstat:

 mk/emulator/README |  54 ++++++++++++++++++++++++++++++++----------------------
 1 files changed, 32 insertions(+), 22 deletions(-)

diffs (75 lines):

diff -r 24301f9a7dae -r dc1a18b3e994 mk/emulator/README
--- a/mk/emulator/README        Sun Jul 29 08:58:52 2007 +0000
+++ b/mk/emulator/README        Sun Jul 29 09:24:33 2007 +0000
@@ -1,18 +1,18 @@
-$NetBSD: README,v 1.1 2007/07/29 08:58:52 jlam Exp $
+$NetBSD: README,v 1.2 2007/07/29 09:24:33 jlam Exp $
 
 The emulator framework handles binary-only packages that require binary
 "emulation" (or ABI re-implementation) on the native operating system.
 
 A package Makefile should set several variables in order to use the
-emulator framework.
+emulator framework:
 
-EMUL_PLATFORMS is a the list of supported <opsys>-<arch> pairs by the
-package and should be set before including bsd.prefs.mk.  The emulator
-framework will select an appropriate supported platform and store it
-in EMUL_PLATFORM.
+    EMUL_PLATFORMS is a the list of supported <opsys>-<arch> pairs by
+       the package and should be set before including bsd.prefs.mk.
+       The emulator framework will select an appropriate supported
+       platform and store it in EMUL_PLATFORM.
 
-EMUL_MODULES.<opsys> is a list of modules from <opsys> that are required
-by the package.
+    EMUL_MODULES.<opsys> is a list of modules from <opsys> that are
+       required by the package.
 
 Example use:
 
@@ -28,20 +28,30 @@
 A user may set several variables in /etc/mk.conf to influence the
 choices made by the emulator framework:
 
-EMUL_PREFER is a list of non-native platforms that should be tried,
-in order, when selecting an appropriate platform.
+    EMUL_PREFER is a list of non-native platforms that should be tried,
+       in order, when selecting an appropriate platform.
+
+    EMUL_TYPE.<opsys> is the distribution of <opsys> that is used when
+       <opsys> is selected for use by the emulator framework.
 
-EMUL_TYPE.<opsys> is the distribution of <opsys> that is used when
-<opsys> is selected for use by the emulator framework.
+       "native" means that the OS is the native operating system.
+       "builtin" means that the OS is installed in some "compat"
+               location that is managed outside of pkgsrc.
+
+       For Linux, there are several additional choices for
+       EMUL_TYPE.linux:
 
-    "native" means that the OS is the native operating system.
-    "builtin" means that the OS is installed in some "compat"
-       location that is managed outside of pkgsrc.
-
-For Linux, there are several additional choices for EMUL_TYPE.linux:
+       "suse" means to use the highest version of SuSE in pkgsrc.
+       "suse-9.1" means to use SuSE 9.1 from pkgsrc.
+       "suse-9.x" means to use the highest version of SuSE 9.x.
+       "suse-10.0" means to use SuSE 10.0 from pkgsrc.
+       "suse-10.x" means to use the highest version of SuSE 10.x.
 
-    "suse" means to use the highest version of SuSE in pkgsrc.
-    "suse-9.1" means to use SuSE 9.1 from pkgsrc.
-    "suse-9.x" means to use the highest version of SuSE 9.x in pkgsrc.
-    "suse-10.0" means to use SuSE 10.0 from pkgsrc.
-    "suse-10.x" means to use the highest version of SuSE 10.x in pkgsrc.
+There are two helper targets for use by package developers:
+
+    "emul-fetch" will cause the distfiles for all platforms listed in
+       EMUL_PLATFORMS to be fetched.
+
+    "emul-distinfo" will generate a "jumbo" distinfo file that contains
+       checksums for the distfiles for all platforms listed in
+       EMUL_PLATFORMS.