expansion doesn't run on man-pages, document Prefix variables in ebuild.5

svn path=/main/branches/prefix/; revision=11083

diff --git a/man/ebuild.1 b/man/ebuild.1
index 17a9ba61f739bf4b00bec7a2ddcfd9a6905f1a5d..5fa2f8116b819eee788dc13cf0088656e60994a9 100644 (file)
--- a/man/ebuild.1
+++ b/man/ebuild.1
@@ -125,7 +125,7 @@ to the live filesystem.  The process works as follows: first, the
 \fIpkg_preinst()\fR function (if specified) is run.  Then, the files
 are merged into the live filesystem, and the installed files' md5
 digests are recorded in
-\fI@DOMAIN_PREFIX@/var/db/pkg/${CATEGORY}/${PN}\-${PVR}/CONTENTS\fR.  After
+\fI/var/db/pkg/${CATEGORY}/${PN}\-${PVR}/CONTENTS\fR.  After
 all the files have been merged, the \fIpkg_postinst()\fR function
 (if specified) is executed.
 .TP
@@ -162,7 +162,7 @@ or other similar setups that the user may wish to run.
 This command is a lot like the \fImerge\fR command, except that after
 fetching, unpacking, compiling and installing, a .tbz2 binary package
 tarball is created and stored in  ${PKGDIR}/All (${PKGDIR} defaults to
-@DOMAIN_PREFIX@/usr/portage/packages).  A symbolic link is created in
+/usr/portage/packages).  A symbolic link is created in
 ${PKGDIR}/${CATEGORY} that points to the package in ${PKGDIR}/All.
 .TP
 .BR rpm
@@ -187,11 +187,11 @@ Mike Frysinger <vapier@gentoo.org>
 .fi
 .SH "FILES"
 .TP
-.B @sysconfdir@/make.conf 
+.B /etc/make.conf 
 Contains variables for the build\-process and overwrites those
 in make.globals.
 .TP
-.B @sysconfdir@/portage/color.map
+.B /etc/portage/color.map
 Contains variables customizing colors.
 .SH "SEE ALSO"
 .BR emerge (1),
@@ -199,6 +199,6 @@ Contains variables customizing colors.
 .BR make.conf (5),
 .BR color.map (5)
 .TP
-The \fI@DOMAIN_PREFIX@/usr/sbin/ebuild.sh\fR script. 
+The \fI/usr/sbin/ebuild.sh\fR script. 
 .TP
-The helper apps in \fI@PORTAGE_BASE@/bin\fR.
+The helper apps in \fI/usr/lib/portage/bin\fR.

diff --git a/man/ebuild.5 b/man/ebuild.5
index 8af8851af40be807bb7bd52a188c5ea18cb22b4f..12e71ae98f8ae66bd6ac6e2afea7690d09158c6c 100644 (file)
--- a/man/ebuild.5
+++ b/man/ebuild.5
@@ -19,6 +19,8 @@ Here's a simple example ebuild:
 # Distributed under the terms of the GNU General Public License v2
 # $Header: $
 
+EAPI="prefix"
+
 inherit some_eclass another_eclass
 
 DESCRIPTION="Super\-useful stream editor (sed)"
@@ -35,7 +37,7 @@ DEPEND="nls? ( sys-devel/gettext )"
 
 src_compile() {
        econf \\
-               \-\-bindir=/bin \\
+               \-\-bindir="${EPREFIX}"/bin \\
                || die "could not configure"
        emake || die "emake failed"
 }
@@ -114,6 +116,10 @@ Contains the path to the temporary \fIinstall directory\fR.  Every write
 operation that does not involve the helper tools and functions (found below)
 should be prefixed with ${D}.  Do not modify this variable.
 .TP
+\fBED\fT = \fI"${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/image/${EPREFIX}"\fR
+Contains the path "${D}${EPREFIX}" for convenience purposes.  Do not
+modify this variable.
+.TP
 .B PORTAGE_LOG_FILE
 Contains the path of the build log. If \fBPORT_LOGDIR\fR variable is unset then
 \fBPORTAGE_LOG_FILE\fR=\fB"${T}/build.log"\fR.
@@ -123,6 +129,12 @@ Contains the path that portage should use as the root of the live filesystem.
 When packages wish to make changes to the live filesystem, they should do so in
 the tree prefixed by ${ROOT}.  Do not modify this variable.
 .TP
+.B EPREFIX
+Contains the offset that this Portage was configured for during
+installation.  The offset is sometimes necessary in an ebuild or eclass,
+and is available in such cases as ${EPREFIX}.  Do not modify this
+variable.
+.TP
 \fBDESCRIPTION\fR = \fI"A happy little package"\fR
 Should contain a short description of the package.
 .TP
@@ -155,7 +167,7 @@ being submitted for inclusion, it must have ~arch set for architectures
 where it has been PROVEN TO WORK.  (Packages KEYWORDed this way may be
 unmasked for testing by setting ACCEPT_KEYWORDS="~arch" on the command
 line, or in \fBmake.conf\fR(5)) For an authoritative list please review
-@DOMAIN_PREFIX@/usr/portage/profiles/arch.list.  Please keep this list in alphabetical order.
+/usr/portage/profiles/arch.list.  Please keep this list in alphabetical order.
 .TP
 \fBSLOT\fR
 This sets the SLOT for packages that may need to have multiple versions
@@ -166,7 +178,7 @@ value should \fINEVER\fR be left undefined.
 \fBLICENSE\fR
 This should be a space delimited list of licenses that the package falls
 under.  This \fB_must_\fR be set to a matching license in
-@DOMAIN_PREFIX@/usr/portage/licenses/. If the license does not exist in portage yet, you
+/usr/portage/licenses/. If the license does not exist in portage yet, you
 must add it first.
 .TP
 \fBIUSE\fR
@@ -619,13 +631,13 @@ directory. The function will append \fIsource\fR to the \fBDISTDIR\fR variable.
 This is used as a replacement for configure.  Performs:
 .nf
 ${\fIECONF_SOURCE\fR:-.}/configure \\
-       \-\-prefix="@DOMAIN_PREFIX@"/usr \\
-       \-\-host=${CHOST} \\
-       \-\-mandir="@DOMAIN_PREFIX@"/usr/share/man \\
-       \-\-infodir="@DOMAIN_PREFIX@"/usr/share/info \\
-       \-\-datadir="@DOMAIN_PREFIX@"/usr/share \\
-       \-\-sysconfdir="@DOMAIN_PREFIX@"/etc \\
-       \-\-localstatedir="@DOMAIN_PREFIX@"/var/lib \\
+       \-\-prefix="${EPREFIX}"/usr \\
+       \-\-host="${EPREFIX}${CHOST} \\
+       \-\-mandir="${EPREFIX}"/usr/share/man \\
+       \-\-infodir="${EPREFIX}"/usr/share/info \\
+       \-\-datadir="${EPREFIX}"/usr/share \\
+       \-\-sysconfdir="${EPREFIX}"/etc \\
+       \-\-localstatedir="${EPREFIX}"/var/lib \\
        \fI${EXTRA_ECONF}\fR \\
        \fIconfigure options\fR
 .fi
@@ -635,7 +647,7 @@ extra arguements to \fBeconf\fR.
 .TP
 \fBemake\fR \fI[make options]\fR
 This is used as a replacement for make.  Performs 'make ${MAKEOPTS}
-\fImake options\fR' (as set in @DOMAIN_PREFIX@/etc/make.globals), default is MAKEOPTS="\-j2".
+\fImake options\fR' (as set in /etc/make.globals), default is MAKEOPTS="\-j2".
 
 \fB***warning***\fR
 .br
@@ -650,12 +662,12 @@ the issue, then you should run '\fBemake\fR \-j1' instead of 'make'.
 This is used as a replacement for make install.  Performs:
 .nf
 make \\
-       prefix="${ED}"/usr \\
-       datadir="${ED}"/usr/share \\
-       infodir="${ED}"/usr/share/info \\
-       localstatedir="${ED}"/var/lib \\
-       mandir="${ED}"/usr/share/man \\
-       sysconfdir="${ED}"/etc \\
+       prefix=${ED}/usr \\
+       datadir=${ED}/usr/share \\
+       infodir=${ED}/usr/share/info \\
+       localstatedir=${ED}/var/lib \\
+       mandir=${ED}/usr/share/man \\
+       sysconfdir=${ED}/etc \\
        \fI${EXTRA_EINSTALL}\fR \\
        \fImake options\fR \\
        install
@@ -731,7 +743,8 @@ multiple directories.
 .TP
 \fBdosed\fR \fI"s:orig:change:g" <filename>\fR
 Performs sed in place on \fIfilename\fR inside ${ED}. If no expression is
-given then \fI"s:${D}::g"\fR is used as the default expression.
+given then \fI"s:${D}::g"\fR is used as the default expression.  Note
+that this expression does \fBNOT\fR use the offset prefix.
 .br
 .BR 'dosed\ "s:/usr/local:/usr:g"\ /usr/bin/some\-script'
 runs sed on ${ED}/usr/bin/some\-script
@@ -906,21 +919,22 @@ Mark Guertin <gerk@gentoo.org>
 Nicholas Jones <carpaski@gentoo.org>
 Mike Frysinger <vapier@gentoo.org>
 Arfrever Frehtes Taifersar Arahesis <Arfrever.FTA@gmail.com>
+Fabian Groffen <grobian@gentoo.org>
 .fi
 .SH "FILES"
 .TP
-The \fI@DOMAIN_PREFIX@/usr/sbin/ebuild.sh\fR script.
+The \fI/usr/sbin/ebuild.sh\fR script.
 .TP
-The helper apps in \fI@PORTAGE_BASE@/bin\fR.
+The helper apps in \fI/usr/lib/portage/bin\fR.
 .TP
-.B @sysconfdir@/make.conf
+.B /etc/make.conf
 Contains variables for the build\-process and overwrites those in make.defaults.
 .TP
-.B @sysconfdir@/make.globals
+.B /etc/make.globals
 Contains the default variables for the build\-process, you should edit
-\fI@sysconfdir@/make.conf\fR instead.
+\fI/etc/make.conf\fR instead.
 .TP
-.B @sysconfdir@/portage/color.map
+.B /etc/portage/color.map
 Contains variables customizing colors.
 .SH "SEE ALSO"
 .BR ebuild (1),

diff --git a/man/emerge.1 b/man/emerge.1
index b928ab53ff30236218329ef7065703f078459965..bc9a7efc8ac6e023c095d5698ed806ceaa5e71a3 100644 (file)
--- a/man/emerge.1
+++ b/man/emerge.1
@@ -719,7 +719,7 @@ this file\fR.
 .BR color.map (5),
 .BR portage (5)
 .LP
-A number of helper applications reside in \fI@PORTAGE_BASE@bin\fR.
+A number of helper applications reside in \fI/usr/lib/portage/bin\fR.
 .LP
 The \fBapp\-portage/gentoolkit\fR package contains useful scripts such as 
 \fBequery\fR (a package query tool).

diff --git a/man/make.conf.5 b/man/make.conf.5
index f05ed33e8ef7e9bc0487c07d2f4e65c8400b0b15..b3dc3c49d5dd2d8072760edb5d9cc54b7498cedc 100644 (file)
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -191,7 +191,7 @@ Portage uses lockfiles to ensure competing instances don't clobber
 each other's files. This feature is enabled by default but may cause
 heartache on less intelligent remote filesystems like NFSv2 and some
 strangely configured Samba server (oplocks off, NFS re\-export). A tool
-@PORTAGE_BASE@bin/clean_locks exists to help handle lock issues
+/usr/lib/portage/bin/clean_locks exists to help handle lock issues
 when a problem arises (normally due to a crash or disconnect).
 .TP
 .B fakeroot
@@ -649,4 +649,4 @@ Contains a list of all local USE variables.
 .TP
 The \fI/usr/sbin/ebuild.sh\fR script. 
 .TP
-The helper apps in \fI@PORTAGE_BASE@/bin\fR.
+The helper apps in \fI/usr/lib/portage/bin\fR.