Merged from trunk 6345:6351
authorFabian Groffen <grobian@gentoo.org>
Sat, 7 Apr 2007 11:44:54 +0000 (11:44 -0000)
committerFabian Groffen <grobian@gentoo.org>
Sat, 7 Apr 2007 11:44:54 +0000 (11:44 -0000)
   +------------------------------------------------------------------------+
   | 6346     | remove references to DOCDESTTREE and INSDESTTREE            |
   | SpankMan |                                                             |
   |----------+-------------------------------------------------------------|
   | 6347     | change "DOCDESTTREE" to "_E_DOCDESTTREE_" to try and        |
   | SpankMan | prevent abuse from ebuild writers                           |
   |----------+-------------------------------------------------------------|
   | 6348     | tell people that the FILES section is not supposed to be    |
   | SpankMan | complete (and sneak in a few style fixups)                  |
   |----------+-------------------------------------------------------------|
   | 6349     | document /var/cache/edb/, /var/db/pkg/, and                 |
   | SpankMan | /var/lib/portage/config                                     |
   |----------+-------------------------------------------------------------|
   | 6350     | remove references to EXEDESTTREE                            |
   | SpankMan |                                                             |
   |----------+-------------------------------------------------------------|
   | 6351     | change "EXEDESTTREE" to "_E_EXEDESTTREE_" to try and        |
   | SpankMan | prevent abuse from ebuild writers                           |
   +------------------------------------------------------------------------+

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

bin/dobin
bin/dodoc
bin/doexe
bin/dohtml
bin/doinitd
bin/ebuild.sh
man/ebuild.5
man/emerge.1
man/portage.5

index bb8639b3b35a6d05ee9cc4f6c43280267cc4b57d..5d06d2ac77576f2861f51e7a6eff3afc3bc13a63 100755 (executable)
--- a/bin/dobin
+++ b/bin/dobin
@@ -3,8 +3,10 @@
 # Distributed under the terms of the GNU General Public License v2
 # $Id: /var/cvsroot/gentoo-src/portage/bin/dobin,v 1.13 2004/10/04 13:56:50 vapier Exp $
 
+source "${PORTAGE_BIN_PATH:-/usr/lib/portage/bin}"/isolated-functions.sh
+
 if [[ $# -lt 1 ]] ; then
-       echo "$0: at least one argument needed" 1>&2
+       vecho "$0: at least one argument needed" 1>&2
        exit 1
 fi
 
@@ -18,7 +20,7 @@ for x in "$@" ; do
        if [[ -e ${x} ]] ; then
                install -m 0755 -o ${PORTAGE_INST_UID:-0} -g ${PORTAGE_INST_GID:-0} "${x}" "${ED}${DESTTREE}/bin"
        else
-               echo "!!! ${0##*/}: ${x} does not exist" 1>&2
+               vecho "!!! ${0##*/}: ${x} does not exist" 1>&2
                false
        fi
        ((ret+=$?))
index 06fbfc055a915224b07a0cd693deb038cae5eae6..db2f7baaf8a609d30e488a95e1e40fda711cfe9d 100755 (executable)
--- a/bin/dodoc
+++ b/bin/dodoc
@@ -8,7 +8,7 @@ if [ $# -lt 1 ] ; then
        exit 1  
 fi
 
-dir="${ED}/usr/share/doc/${PF}/${DOCDESTTREE}"
+dir="${ED}/usr/share/doc/${PF}/${_E_DOCDESTTREE_}"
 if [ ! -d "${dir}" ] ; then
        install -d "${dir}"
 fi
index 8980b55e324540da001eacb9a1c5c325fcf7f8f5..2bd8406148a69d02e16d42d1c5cd173f17d67a9d 100755 (executable)
--- a/bin/doexe
+++ b/bin/doexe
@@ -1,5 +1,5 @@
 #!@BASH@
-# Copyright 1999-2006 Gentoo Foundation
+# Copyright 1999-2007 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 # $Id: /var/cvsroot/gentoo-src/portage/bin/doexe,v 1.10.2.1 2004/12/06 03:01:43 carpaski Exp $
 
@@ -9,7 +9,7 @@ if [[ $# -lt 1 ]] ; then
 fi
 
 if [[ ! -d ${ED}${EXEDESTTREE} ]] ; then
-       install -d "${ED}${EXEDESTTREE}"
+       install -d "${ED}${_E_EXEDESTTREE_}"
 fi
 
 for x in "$@" ; do
@@ -22,5 +22,5 @@ for x in "$@" ; do
        else
                mysrc="${x}"
        fi
-       install ${EXEOPTIONS} "${mysrc}" "${ED}${EXEDESTTREE}"
+       install ${EXEOPTIONS} "${mysrc}" "${ED}${_E_EXEDESTTREE_}"
 done
index e105dc4deb5555a737bab28f706cf4dbfa592845..517683f71a3b6a060c3772174618230ace3939bb 100755 (executable)
@@ -77,8 +77,8 @@ class OptionsClass:
                        self.PF = os.environ["PF"]
                if os.environ.has_key("ED"):
                        self.ED = os.environ["ED"]
-               if os.environ.has_key("DOCDESTTREE"):
-                       self.DOCDESTTREE = os.environ["DOCDESTTREE"]
+               if os.environ.has_key("_E_DOCDESTTREE_"):
+                       self.DOCDESTTREE = os.environ["_E_DOCDESTTREE_"]
                
                self.allowed_exts = [ 'png', 'gif', 'html', 'htm', 'jpg', 'css', 'js' ]
                self.allowed_files = []
index 3f579462d52a36721d40a8a2e23d30ab142d5cc5..dcfcf734ab896b95e44387e153a74c08ec22ad10 100755 (executable)
@@ -1,5 +1,5 @@
 #!@BASH@
-# Copyright 1999-2006 Gentoo Foundation
+# Copyright 1999-2007 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 # $Id: /var/cvsroot/gentoo-src/portage/bin/doinitd,v 1.2.2.1 2005/01/13 04:51:56 vapier Exp $
 
@@ -10,5 +10,5 @@ fi
 
 exec \
 env \
-EXEDESTTREE="/etc/init.d/" \
+_E_EXEDESTTREE_="/etc/init.d/" \
 doexe "$@"
index f3f871b66afed1eed5ae4c4c9822fd78711ef183..98d337929622bc03014b4bf9cda2a912ebf2e092 100755 (executable)
@@ -1,5 +1,5 @@
 #!@BASH@
-# Copyright 1999-2006 Gentoo Foundation
+# Copyright 1999-2007 Gentoo Foundation
 # Distributed under the terms of the GNU General Public License v2
 # $Id$
 
@@ -422,8 +422,8 @@ register_die_hook() {
 umask 022
 export DESTTREE=/usr
 export INSDESTTREE=""
-export EXEDESTTREE=""
-export DOCDESTTREE=""
+export _E_EXEDESTTREE_=""
+export _E_DOCDESTTREE_=""
 export INSOPTIONS="-m0644"
 export EXEOPTIONS="-m0755"
 export LIBOPTIONS="-m0644"
@@ -905,22 +905,22 @@ insinto() {
 
 exeinto() {
        if [ "$1" == "/" ]; then
-               export EXEDESTTREE=""
+               export _E_EXEDESTTREE_=""
        else
                export EXEDESTTREE="$1"
-               if [ ! -d "${ED}${EXEDESTTREE}" ]; then
-                       install -d "${ED}${EXEDESTTREE}"
+               if [ ! -d "${ED}${_E_EXEDESTTREE_}" ]; then
+                       install -d "${ED}${_E_EXEDESTTREE_}"
                fi
        fi
 }
 
 docinto() {
        if [ "$1" == "/" ]; then
-               export DOCDESTTREE=""
+               export _E_DOCDESTTREE_=""
        else
                export DOCDESTTREE="$1"
-               if [ ! -d "${ED}usr/share/doc/${PF}/${DOCDESTTREE}" ]; then
-                       install -d "${ED}usr/share/doc/${PF}/${DOCDESTTREE}"
+               if [ ! -d "${ED}usr/share/doc/${PF}/${_E_DOCDESTTREE_}" ]; then
+                       install -d "${ED}usr/share/doc/${PF}/${_E_DOCDESTTREE_}"
                fi
        fi
 }
index c4296d053a7b7187d0a40b2692786ff9d7d02ff6..4d8c4aea9a6e38108dfedd3101b0ae01dfd923a5 100644 (file)
@@ -800,37 +800,38 @@ Performs chown (\fBfowners\fR) or chmod (\fBfperms\fR), applying
 \fIpermissions\fR to \fIfiles\fR.
 .TP
 \fBinsinto\fR \fI[path]\fR
-Sets the root (\fIINSDESTTREE\fR) for the \fBdoins\fR function.
+Sets the destination path for the \fBdoins\fR function.
 .br
-The default root is /.
+The default path is /.
 .TP
 \fBinsopts\fR \fI[options for install(1)]\fR
 Can be used to define options for the install function used in
 \fBdoins\fR.  The default is \fI\-m0644\fR.
 .TP
 \fBdoins\fR \fI<file> [list of more files]\fR
-Installs files into \fIINSDESTTREE\fR.  This function uses \fBinstall\fR(1).  
-Creates all necessary dirs.
+Installs files into the path controlled by \fBinsinto\fR.  This function
+uses \fBinstall\fR(1).  Creates all necessary dirs.
 .TP
 \fBexeinto\fR \fI[path]\fR
-Sets the root (\fIEXEDESTTREE\fR) for the \fBdoexe\fR function.
+Sets the destination path for the \fBdoexe\fR function.
 .br
-The default root is /.
+The default path is /.
 .TP
 \fBexeopts\fR \fI[options for install(1)]\fR
 Can be used to define options for the install function used in \fBdoexe\fR.
 The default is \fI\-m0755\fR.
 .TP
 \fBdoexe\fR \fI<executable> [list of more executables]\fR
-Installs a executable or a list of executable into \fIEXEDESTTREE\fR.
-This function uses \fBinstall\fR(1).  Creates all necessary dirs.
+Installs executables into the path controlled by \fBexecinto\fR.  This function
+uses \fBinstall\fR(1).  Creates all necessary dirs.
 .TP
 \fBdocinto\fR \fI[path]\fR
-Sets the relative subdir (\fIDOCDESTTREE\fR) used by \fBdodoc\fR.
+Sets the subdir used by \fBdodoc\fR when installing into the document tree
+(based in /usr/share/doc/${PF}/).  Default is no subdir, or just "".
 .TP
 \fBdodoc\fR \fI<document> [list of more documents]\fR
-Installs a document or a list of document into /usr/share/doc/${PF}/\fIDOCDESTTREE\fR.
-Files are automatically gzipped.  Creates all necessary dirs.
+Installs a document or a list of documents into /usr/share/doc/${PF}/\fI<docinto path>\fR.
+Documents are marked for compression.  Creates all necessary dirs.
 
 .PD 0
 .TP
index 881ac512685813dea494992f067de9d22625540a..ded52273e0ae7dbf3a8cf1c1d137051e2b527072 100644 (file)
@@ -554,13 +554,15 @@ Mike Frysinger <vapier@gentoo.org>
 Marius Mauch <genone@gentoo.org>
 .fi
 .SH "FILES"
+Here is a common list of files you will probably be interested in.  For a 
+complete listing, please refer to the \fBportage\fR(5) man page.
 .TP
-\fB/var/lib/portage/world\fR 
+.B /var/lib/portage/world
 Contains a list of all user\-specified packages.  You can safely edit
 this file, adding packages that you want to be considered in \fBworld\fR
 set updates and removing those that you do not want to be considered.
 .TP
-\fB/etc/make.conf\fR 
+.B /etc/make.conf
 Contains variables for the build process, overriding those in
 \fBmake.globals\fR.  \fBYou should edit this file instead of the ones
 listed below\fR.
@@ -569,27 +571,27 @@ listed below\fR.
 Contains settings to handle automatic updates/backups of configuration 
 files.
 .TP
-\fB/etc/make.profile/make.defaults\fR
+.B /etc/make.profile/make.defaults
 Contains profile\-specific variables for the build process.  \fBDo not
 edit this file\fR.
 .TP
-\fB/etc/make.profile/use.defaults\fR
+.B /etc/make.profile/use.defaults
 Contains a list of packages which, if installed, cause the respective USE 
 flag to be enabled by default.  \fBDo not edit this file\fR.
 .TP
-\fB/usr/portage/profiles/use.desc\fR 
+.B /usr/portage/profiles/use.desc
 Contains the master list of USE flags with descriptions of their
 functions.  \fBDo not edit this file\fR.
 .TP
-\fB/etc/make.profile/virtuals\fR 
+.B /etc/make.profile/virtuals
 Contains a list of default packages used to resolve virtual dependencies.
 \fBDo not edit this file\fR.
 .TP
-\fB/etc/make.profile/packages\fR
+.B /etc/make.profile/packages
 Contains a list of packages used for the base system.  The \fBsystem\fR
 and \fBworld\fR sets consult this file.  \fBDo not edit this file\fR.
 .TP
-\fB/etc/make.globals\fR 
+.B /etc/make.globals
 Contains the default variables for the build process.  \fBDo not edit
 this file\fR.
 .SH "SEE ALSO"
index 9c3ae32cf765027045c560a37787df5f2309a947..18db633444dcd4dea5905334926736890bda504c 100644 (file)
@@ -66,8 +66,17 @@ use.desc
 use.local.desc
 .fi
 .TP
+.BR /var/cache/edb/
+misc internal cache files
+.TP
+.BR /var/db/pkg/
+database to track installed packages
+.TP
 .BR /var/lib/portage/
+.nf
+config
 world
+.fi
 .SH "GLOSSARY"
 In the following sections, some terminology may be foreign to you or used 
 with meaning specific to Portage.  Please see the referenced manpages for 
@@ -646,9 +655,46 @@ games\-emulation/xmess:net \- Adds network support
 .fi
 .RE
 .TP
+.BR /var/cache/edb/
+.RS
+This directory is used to store internal portage cache files.  The names and
+purpose of these files are not documented on purpose so as to keep down bitrot
+as internals change.  If you aren't working on portage internally, then the
+details most likely do not matter to you.
+
+This entire directory can be safely deleted.  It is highly recommended you do
+not do this however as it can be a time consuming process to generate them all
+again.
+.RE
+.TP
+.BR /var/db/pkg/
+.RS
+All installed package information is recorded here.  If portage thinks you have
+a package installed, it is usually because it is listed here.
+
+The format follows somewhat closely that of the portage tree.  There is a
+directory for each category and a package-version subdirectory for each package
+you have installed.
+
+Inside each package directory are misc files that describe the installed
+contents of the package as well as build time information (so that the package
+can be unmerged without needing the portage tree).
+
+The exact file contents and format are not described here again so that things
+can be changed quickly.  Generally though there is one file per environment
+variable that "matters" (like CFLAGS) with the contents stored inside of it.
+Another common file is the CONTENTS file which lists the path and hashes of
+all objects that the package installed onto your system.
+.RE
+.TP
 .BR /var/lib/portage/
 .RS
 .TP
+.BR config
+Hashes which are used to determine whether files in config protected
+directories have been modified since being installed.  Files which have not
+been modified will automatically be unmerged.
+.TP
 .BR world
 Every time you emerge a package, the package that you requested is 
 recorded here.  Then when you run `emerge world \-up`, the list of