Added more verbose wording and examples for pkgcache_path and kerncache_path, where necessary.

git-svn-id: svn+ssh://svn.gentoo.org/var/svnroot/catalyst/trunk@1049 d1e1f19c-881f-0410-ab34-b69fee027534

6 files changed, 51 insertions, 35 deletions

diff --git a/examples/generic_stage_template.spec b/examples/generic_stage_template.spec
index 7bc3d9ce..6abdf603 100644
--- a/examples/generic_stage_template.spec
+++ b/examples/generic_stage_template.spec
@@ -59,6 +59,14 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
+# This allows the optional directory containing the output packages for
+# catalyst.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# pkgcache_path: /tmp/packages
+pkgcache_path:
+
 # These options are only available when building a stage1 or stage2 target and
 # are all optional.  These allow for emulating the changes possible during ai
 # bootstrap.  Some possible uses of these would be building embedded stages
@@ -91,9 +99,3 @@ cxxflags:
 # example:
 # ldflags: -Wl,-O1 -Wl,-z,now
 ldflags:
-
-# Setting the option overrides the location of the pkgcache
-pkgcache_path:
-
-# Setting the option overrides the location of the kerncache
-kerncache_path:
diff --git a/examples/grp_template.spec b/examples/grp_template.spec
index 4ccbc2e3..3e5e3163 100644
--- a/examples/grp_template.spec
+++ b/examples/grp_template.spec
@@ -106,10 +106,3 @@ grp/cd2/type:
 # example:
 # grp/cd2/packages: dante tsocks sys-apps/eject minicom links acpid apmd parted whois tcpdump cvs zip unzip netcat partimage app-admin/sudo app-cdr/cdrtools gnome emacs dev-lang/ruby enlightenment kde mozilla-firefox mozilla-thunderbird xfce4 openbox fluxbox sylpheed openoffice-bin gimp xemacs xmms abiword gaim xchat pan tetex xcdroast k3b samba nmap gradm ettercap ethereal mplayer
 grp/cd2/packages:
-
-# Setting the option overrides the location of the pkgcache
-pkgcache_path:
-
-# Setting the option overrides the location of the kerncache
-kerncache_path:
-
diff --git a/examples/livecd-stage1_template.spec b/examples/livecd-stage1_template.spec
index 529881b7..cadeac20 100644
--- a/examples/livecd-stage1_template.spec
+++ b/examples/livecd-stage1_template.spec
@@ -80,8 +80,3 @@ livecd/use:
 # example:
 # livecd/packages: livecd-tools dhcpcd acpid apmd gentoo-sources coldplug fxload irssi gpm syslog-ng parted links raidtools dosfstools nfs-utils jfsutils xfsprogs e2fsprogs reiserfsprogs ntfsprogs pwgen rp-pppoe screen mirrorselect penggy iputils hwdata-knoppix hwsetup lvm2 evms vim pptpclient mdadm ethtool wireless-tools prism54-firmware wpa_supplicant
 livecd/packages:
-
-# Setting the option overrides the location of the pkgcache
-pkgcache_path:
-
-
diff --git a/examples/livecd-stage2_template.spec b/examples/livecd-stage2_template.spec
index 97d39391..56b6febc 100644
--- a/examples/livecd-stage2_template.spec
+++ b/examples/livecd-stage2_template.spec
@@ -56,6 +56,22 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
+# This allows the optional directory containing the output packages for
+# catalyst.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# pkgcache_path: /tmp/packages
+pkgcache_path:
+
+# This allows the optional directory containing the output packages for kernel
+# builds.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# kerncache_path: /tmp/kernel
+kerncache_path:
+
 # The fstype is used to determine what sort of CD we should build.  This is
 # used to set the type of loopback filesystem that we will use on our CD.
 # Possible options are as follows:
@@ -318,10 +334,3 @@ livecd/empty:
 # example:
 # livecd/rm: /lib/*.a /usr/lib/*.a /usr/lib/gcc-lib/*/*/libgcj* /etc/dispatch-conf.conf /etc/etc-update.conf /etc/*- /etc/issue* /etc/make.conf /etc/man.conf /etc/*.old /root/.viminfo /usr/sbin/bootsplash* /usr/sbin/fb* /usr/sbin/fsck.cramfs /usr/sbin/fsck.minix /usr/sbin/mkfs.minix /usr/sbin/mkfs.bfs /usr/sbin/mkfs.cramfs /lib/security/pam_access.so /lib/security/pam_chroot.so /lib/security/pam_debug.so /lib/security/pam_ftp.so /lib/security/pam_issue.so /lib/security/pam_mail.so /lib/security/pam_motd.so /lib/security/pam_mkhomedir.so /lib/security/pam_postgresok.so /lib/security/pam_rhosts_auth.so /lib/security/pam_userdb.so /usr/share/consolefonts/1* /usr/share/consolefonts/7* /usr/share/consolefonts/8* /usr/share/consolefonts/9* /usr/share/consolefonts/A* /usr/share/consolefonts/C* /usr/share/consolefonts/E* /usr/share/consolefonts/G* /usr/share/consolefonts/L* /usr/share/consolefonts/M* /usr/share/consolefonts/R* /usr/share/consolefonts/a* /usr/share/consolefonts/c* /usr/share/consolefonts/dr* /usr/share/consolefonts/g* /usr/share/consolefonts/i* /usr/share/consolefonts/k* /usr/share/consolefonts/l* /usr/share/consolefonts/r* /usr/share/consolefonts/s* /usr/share/consolefonts/t* /usr/share/consolefonts/v* /etc/splash/livecd-2005.0/16* /etc/splash/livecd-2005.0/12* /etc/splash/livecd-2005.0/6* /etc/splash/livecd-2005.0/8* /etc/splash/livecd-2005.0/images/silent-16* /etc/splash/livecd-2005.0/images/silent-12* /etc/splash/livecd-2005.0/images/silent-6* /etc/splash/livecd-2005.0/images/silent-8* /etc/splash/livecd-2005.0/images/verbose-16* /etc/splash/livecd-2005.0/images/verbose-12* /etc/splash/livecd-2005.0/images/verbose-6* /etc/splash/livecd-2005.0/images/verbose-8* /etc/make.conf.example /etc/make.globals /etc/resolv.conf
 livecd/rm:
-
-# Setting the option overrides the location of the pkgcache
-pkgcache_path:
-
-# Setting the option overrides the location of the kerncache
-kerncache_path:
-
diff --git a/examples/netboot_template.spec b/examples/netboot_template.spec
index 2caf28fb..3b4b1f6e 100644
--- a/examples/netboot_template.spec
+++ b/examples/netboot_template.spec
@@ -56,6 +56,22 @@ distcc_hosts:
 # portage_confdir: /etc/portage
 portage_confdir:
 
+# This allows the optional directory containing the output packages for
+# catalyst.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# pkgcache_path: /tmp/packages
+pkgcache_path:
+
+# This allows the optional directory containing the output packages for kernel
+# builds.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# kerncache_path: /tmp/kernel
+kerncache_path:
+
 # This option tells catalyst which kernel sources to merge for building this
 # image.  This can use normal portage atoms to specify a specific version.
 # example:
diff --git a/examples/stage4_template.spec b/examples/stage4_template.spec
index f5d87f79..1b8196be 100644
--- a/examples/stage4_template.spec
+++ b/examples/stage4_template.spec
@@ -64,9 +64,17 @@ portage_confdir:
 # pkgcache_path: /tmp/packages
 pkgcache_path:
 
-# The stage4 target is where you will build packages for basically updated stage3.
-# These packages can be built with customized USE settings.  The settings here are
-# additive to the default USE configured by the profile.  
+# This allows the optional directory containing the output packages for kernel
+# builds.  Mainly used as a way for different spec files to access the same
+# cache directory.  Default behavior is for this location to be autogenerated
+# by catalyst based on the spec file.
+# example:
+# kerncache_path: /tmp/kernel
+kerncache_path:
+
+# The stage4 target is where you will build packages for basically updated
+# stage3.  These packages can be built with customized USE settings.  The
+# settings here are additive to the default USE configured by the profile.  
 # Leaving this blank will default to the system use flags
 # example:
 # stage4/use: ipv6 socks5 fbcon ncurses readline ssl
@@ -256,10 +264,3 @@ stage4/empty:
 # example:
 # stage4/rm: /lib/*.a /usr/lib/*.a /usr/lib/gcc-lib/*/*/libgcj* /etc/dispatch-conf.conf /etc/etc-update.conf /etc/*- /etc/issue* /etc/make.conf /etc/man.conf /etc/*.old /root/.viminfo /usr/sbin/bootsplash* /usr/sbin/fb* /usr/sbin/fsck.cramfs /usr/sbin/fsck.minix /usr/sbin/mkfs.minix /usr/sbin/mkfs.bfs /usr/sbin/mkfs.cramfs /lib/security/pam_access.so /lib/security/pam_chroot.so /lib/security/pam_debug.so /lib/security/pam_ftp.so /lib/security/pam_issue.so /lib/security/pam_mail.so /lib/security/pam_motd.so /lib/security/pam_mkhomedir.so /lib/security/pam_postgresok.so /lib/security/pam_rhosts_auth.so /lib/security/pam_userdb.so /usr/share/consolefonts/1* /usr/share/consolefonts/7* /usr/share/consolefonts/8* /usr/share/consolefonts/9* /usr/share/consolefonts/A* /usr/share/consolefonts/C* /usr/share/consolefonts/E* /usr/share/consolefonts/G* /usr/share/consolefonts/L* /usr/share/consolefonts/M* /usr/share/consolefonts/R* /usr/share/consolefonts/a* /usr/share/consolefonts/c* /usr/share/consolefonts/dr* /usr/share/consolefonts/g* /usr/share/consolefonts/i* /usr/share/consolefonts/k* /usr/share/consolefonts/l* /usr/share/consolefonts/r* /usr/share/consolefonts/s* /usr/share/consolefonts/t* /usr/share/consolefonts/v* /etc/splash/livecd-2005.0/16* /etc/splash/livecd-2005.0/12* /etc/splash/livecd-2005.0/6* /etc/splash/livecd-2005.0/8* /etc/splash/livecd-2005.0/images/silent-16* /etc/splash/livecd-2005.0/images/silent-12* /etc/splash/livecd-2005.0/images/silent-6* /etc/splash/livecd-2005.0/images/silent-8* /etc/splash/livecd-2005.0/images/verbose-16* /etc/splash/livecd-2005.0/images/verbose-12* /etc/splash/livecd-2005.0/images/verbose-6* /etc/splash/livecd-2005.0/images/verbose-8* /etc/make.conf.example /etc/make.globals /etc/resolv.conf
 stage4/rm:
-
-# Setting the option overrides the location of the pkgcache
-pkgcache_path:
-
-# Setting the option overrides the location of the kerncache
-kerncache_path:
-