Better formatting for the package- and user-settable variables, and

document the emul-* helper targets.

1 files changed, 31 insertions, 21 deletions

diff --git a/mk/emulator/README b/mk/emulator/README
index 9df20b37db2..93a1496463a 100644
--- a/mk/emulator/README
+++ b/mk/emulator/README
@@ -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 @@ Example use:
 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.
+	"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:
+	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 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.
+	"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.
+
+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.