diff options
author | 2004-09-15 06:40:34 +0000 | |
---|---|---|
committer | 2004-09-15 06:40:34 +0000 | |
commit | a3a069e5aee43873c4849e608562b64575ffb3ba (patch) | |
tree | 7a24648e2e6191880dfcfbc650cee578b5c69a0a /man | |
parent | Fairly simple updates. Name changes in the man pages. A missing Manifest (diff) | |
download | portage-cvs-a3a069e5aee43873c4849e608562b64575ffb3ba.tar.gz portage-cvs-a3a069e5aee43873c4849e608562b64575ffb3ba.tar.bz2 portage-cvs-a3a069e5aee43873c4849e608562b64575ffb3ba.zip |
Some touchups and _rc1.
Diffstat (limited to 'man')
-rw-r--r-- | man/ebuild.5 | 29 | ||||
-rw-r--r-- | man/emerge.1 | 18 |
2 files changed, 35 insertions, 12 deletions
diff --git a/man/ebuild.5 b/man/ebuild.5 index 9ccfb9d..f9290f0 100644 --- a/man/ebuild.5 +++ b/man/ebuild.5 @@ -20,7 +20,8 @@ Here's a simple example ebuild: # $Header: $ .br - +inherit some_eclass another_eclass +.br DESCRIPTION="Super\-useful stream editor (sed)" .br SRC_URI="ftp://alpha.gnu.org/pub/gnu/sed/${P}.tar.gz" @@ -361,6 +362,16 @@ This variable should only be used when a package provides a virtual target. For example, blackdown-jdk and sun-jdk provide \fIvirtual/jdk\fR. This allows for packages to depend on \fIvirtual/jdk\fR rather than on blackdown or sun specifically. +.SH "PORTAGE DECLARATIONS" +.TP +.B inherit +Inherit is portage's maintainance of extra classes of functions that +are external to ebuilds and provided as inheritable capabilities and +data. They define functions and set data types as drop-in replacements, +expanded, and simplified routines for extremely common tasks to streamline +the build process. Inherit may only be called once in an ebuild and it may +\fBnever be wrapped within any conditionals\fR of any kind. Specification of +the eclasses contains only their name and not the \fI.eclass\fR extention. .SH "FUNCTIONS" .TP .B pkg_nofetch @@ -425,19 +436,21 @@ include \fIreason\fR. \fBuse\fR \fI<USE item>\fR If \fIUSE item\fR is in the \fBUSE\fR variable, \fIUSE item\fR will be echoed and the function will return 0. If \fIUSE item\fR is not in the -\fBUSE\fR variable, the function will return 1. +\fBUSE\fR variable, the function will return 1. \fBuseq\fR is a non-echoing +version of \fBuse\fR and should be used as often as possible instead of +interpreting or handling the output of \fBuse\fR. .RS .TP .I Example: -if use gnome ; then +if useq gnome ; then .br guiconf="--enable-gui=gnome --with-x" .br -elif use gtk ; then +elif useq gtk ; then .br guiconf="--enable-gui=gtk --with-x" .br -elif use X ; then +elif useq X ; then .br guiconf="--enable-gui=athena --with-x" .br @@ -492,7 +505,9 @@ See \fBuse_with\fR for an example. .TP \fBhas\fR \fI<item>\fR \fI<item list>\fR If \fIitem\fR is in \fIitem list\fR, then \fIitem\fR is echoed and \fBhas\fR -returns 0. Otherwise, nothing is echoed and 1 is returned. +returns 0. Otherwise, nothing is echoed and 1 is returned. As indicated with +use, there is a non-echoing version \fBhasq\fR. Please use \fBhasq\fR in all +places where output is to be disregarded. Never use the output for calculation. .br The \fIitem list\fR is delimited by the \fIIFS\fR variable. This variable has a default value of ' ', or a space. It is a \fBbash\fR(1) setting. @@ -867,4 +882,4 @@ Nicholas Jones <carpaski@gentoo.org> Mike Frysinger <vapier@gentoo.org> .fi .SH "CVS HEADER" -$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/ebuild.5,v 1.67 2004/08/31 02:38:03 vapier Exp $ +$Header: /local/data/ulm/cvs/history/var/cvsroot/gentoo-src/portage/man/ebuild.5,v 1.68 2004/09/15 06:40:34 carpaski Exp $ diff --git a/man/emerge.1 b/man/emerge.1 index 8737b51..dc04bed 100644 --- a/man/emerge.1 +++ b/man/emerge.1 @@ -10,7 +10,7 @@ emerge \- Command\-line interface to the Portage system [\fIoptions\fR] [\fIaction\fR] \fBebuildfile\fR .TP .BR emerge -\fBsync\fR | \fBrsync\fR +\fBsync\fR | \fBmetadata\fR .TP .BR emerge \fI\-\-help \-h\fR [\fBsystem\fR | \fBconfig\fR | \fBsync\fR] @@ -114,6 +114,12 @@ your own packages. You \fBmust\fR specify a category and particular version of a package for injecting. For example, \fBemerge inject sys\-kernel/gentoo\-sources\-2.4.19\fR. .TP +.BR metadata +Causes portage to process all the metacache files as is normally done +on the tail end of an rsync update using \fBemerge sync\fR. The processing +creates the cache database that portage uses for pre-parsed lookups of +package data. +.TP .BR "prune " (\fB\-P\fR) \fBWARNING: This action can remove important packages!\fR Removes all but the latest versions of matching packages. If there are @@ -131,7 +137,9 @@ and the building of dependency trees. This command is not recommended for rsync users as rsync updates the cache using server\-side caches. If you do not know the differences between a 'rsync user' and some other user, then you are a 'rsync user' :). Rsync users should simply run -\fBemerge sync\fR to regenerate the cache. +\fBemerge sync\fR to regenerate the cache. After a portage updated, rsync +users may find it convenient to run \fBemerge metadata\fR to rebuild the +cache as portage does at the end of a sync operation. .TP .BR "search " (\fB\-s\fR) Searches for matches of the supplied string in the portage tree. @@ -301,8 +309,8 @@ cases where skipping the package will not result in failed dependencies. .TP .BR "\-\-tree " (\fB\-t\fR) Shows the dependency tree for the given target by indenting dependencies. -Only really useful in combination with \fB\-\-emptytree\fR, \fB\-\-update\fR -or \fB\-\-deep\fR. +Only really useful in combination with "\fB\-\-emptytree\fR" or "\fB\-\-update\fR +and \fB\-\-deep\fR". .TP .BR "\-\-update " (\fB\-u\fR) Updates packages to the best version available, which may not @@ -537,4 +545,4 @@ Phil Bordelon <phil@thenexusproject.org> .br Mike Frysinger <vapier@gentoo.org> .SH "CVS HEADER" -$Id: emerge.1,v 1.58 2004/08/06 05:42:37 vapier Exp $ +$Id: emerge.1,v 1.59 2004/09/15 06:40:34 carpaski Exp $ |