aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorArfrever Frehtes Taifersar Arahesis <Arfrever@Apache.Org>2014-01-06 19:21:11 +0100
committerArfrever Frehtes Taifersar Arahesis <Arfrever@Apache.Org>2014-01-06 19:21:11 +0100
commit7757dc3c7d1ba2cc401de6e970ec06f3a4df326d (patch)
tree54c6463aa5a60730e294c5d3676c04c3b7c3d3e2 /man
parentUpdate the release notes for a release. (diff)
downloadportage-7757dc3c7d1ba2cc401de6e970ec06f3a4df326d.tar.gz
portage-7757dc3c7d1ba2cc401de6e970ec06f3a4df326d.tar.bz2
portage-7757dc3c7d1ba2cc401de6e970ec06f3a4df326d.zip
Delete some references to deprecated PORTDIR and PORTDIR_OVERLAY variables in documentation.
Diffstat (limited to 'man')
-rw-r--r--man/ebuild.513
-rw-r--r--man/emerge.118
-rw-r--r--man/make.conf.525
-rw-r--r--man/portage.535
4 files changed, 45 insertions, 46 deletions
diff --git a/man/ebuild.5 b/man/ebuild.5
index 960b2dfb2..524006a5a 100644
--- a/man/ebuild.5
+++ b/man/ebuild.5
@@ -1,4 +1,4 @@
-.TH "EBUILD" "5" "Jul 2013" "Portage VERSION" "Portage"
+.TH "EBUILD" "5" "Jan 2014" "Portage VERSION" "Portage"
.SH "NAME"
ebuild \- the internal format, variables, and functions in an ebuild script
@@ -363,8 +363,9 @@ during compilation.
.SH "VARIABLES"
.TP
.B Usage Notes
-\- All variables defined in \fBmake.conf\fR(5) are available for use in
-ebuilds (such as the PORTAGE* and PORTDIR* variables)
+\- Variables defined in \fBmake.conf\fR(5) are available for use in
+ebuilds (except Portage\-specific variables, which might be not supported by
+other package managers).
.br
\- When assigning values to variables in ebuilds, you \fIcannot have a
space\fR between the variable name and the equal sign.
@@ -413,9 +414,9 @@ not be defined. It is autogenerated from the \fBSRC_URI\fR variable.
.B WORKDIR\fR = \fI"${PORTAGE_TMPDIR}/portage/${CATEGORY}/${PF}/work"
Contains the path to the package build root. Do not modify this variable.
.TP
-.B FILESDIR\fR = \fI"${PORTDIR}/${CATEGORY}/${PN}/files"
-Contains the path to the 'files' sub folder in the package specific
-location in the portage tree. Do not modify this variable.
+.B FILESDIR\fR = \fI"${repository_location}/${CATEGORY}/${PN}/files"
+Contains the path to the 'files' subdirectory in the package specific
+location in given repository. Do not modify this variable.
.TP
.B EBUILD_PHASE
Contains the abreviated name of the phase function that is
diff --git a/man/emerge.1 b/man/emerge.1
index c59185f24..7b507fed8 100644
--- a/man/emerge.1
+++ b/man/emerge.1
@@ -1,4 +1,4 @@
-.TH "EMERGE" "1" "Aug 2013" "Portage VERSION" "Portage"
+.TH "EMERGE" "1" "Jan 2014" "Portage VERSION" "Portage"
.SH "NAME"
emerge \- Command\-line interface to the Portage system
.SH "SYNOPSIS"
@@ -175,12 +175,12 @@ with the \fI\-\-verbose\fR option.
Displays a list of available package sets.
.TP
.BR \-\-metadata
-Transfers metadata cache from ${PORTDIR}/metadata/md5\-cache/ to
-/var/cache/edb/dep/ as is normally done on the
-tail end of an rsync update using \fBemerge \-\-sync\fR. This process
-populates the cache database that portage uses for pre-parsed lookups of
-package data. It does not populate cache for the overlays listed in
-PORTDIR_OVERLAY. In order to generate cache for overlays, use \fB\-\-regen\fR.
+Transfers pregenerated metadata cache from ${repository_location}/metadata/md5\-cache/
+to /var/cache/edb/dep/ as is normally done on the tail end of an rsync update using
+\fBemerge \-\-sync\fR. This process populates the cache database that Portage uses
+for pre-parsed lookups of package data. It does not populate cache for repositories
+not distributing pregenerated metadata cache. In order to generate cache for these
+repositories, use \fB\-\-regen\fR.
In versions of portage >=2.1.5 the \-\-metadata action is totally unnecessary
unless the user has enabled FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
.TP
@@ -824,8 +824,8 @@ dependencies.
.BR "\-\-usepkgonly [ y | n ] (\-K short option)"
Tells emerge to only use binary packages (from $PKGDIR). All the binary
packages must be available at the time of dependency calculation or emerge
-will simply abort. Portage does not use $PORTDIR when calculating dependency
-information so all masking information is ignored.
+will simply abort. Portage does not use ebuild repositories when calculating
+dependency information so all masking information is ignored.
.TP
.BR "\-\-verbose [ y | n ] (\-v short option)"
Tell emerge to run in verbose mode. Currently this flag causes emerge to print
diff --git a/man/make.conf.5 b/man/make.conf.5
index c271d1744..80f642f12 100644
--- a/man/make.conf.5
+++ b/man/make.conf.5
@@ -1,4 +1,4 @@
-.TH "MAKE.CONF" "5" "Aug 2013" "Portage VERSION" "Portage"
+.TH "MAKE.CONF" "5" "Jan 2014" "Portage VERSION" "Portage"
.SH "NAME"
make.conf \- custom settings for Portage
.SH "SYNOPSIS"
@@ -410,7 +410,7 @@ This feature is enabled by default.
Automatically perform a metadata transfer when `emerge \-\-sync` is run.
In versions of portage >=2.1.5, this feature is disabled by
default. When metadata\-transfer is disabled, metadata cache from the
-${PORTDIR}/metadata/md5\-cache/ directory will be used directly
+${repository_location}/metadata/md5\-cache/ directory will be used directly
(if available).
.TP
.B mirror
@@ -607,11 +607,11 @@ Enable the sandbox in the compile phase, when running without root privs
(\fIuserpriv\fR).
.TP
.B usersync
-Drop privileges to the owner of \fBPORTDIR\fR for \fBemerge(1) --sync\fR
+Drop privileges to the owner of ${repository_location} for \fBemerge(1) --sync\fR
operations. Note that this feature assumes that all subdirectories of
-\fBPORTDIR\fR have the same ownership as \fBPORTDIR\fR itself. It is the
-user's responsibility to ensure correct ownership, since otherwise portage
-would have to waste time validating ownership for each and every sync
+${repository_location} have the same ownership as ${repository_location} itself.
+It is the user's responsibility to ensure correct ownership, since otherwise
+Portage would have to waste time validating ownership for each and every sync
operation.
.TP
.B webrsync-gpg
@@ -907,8 +907,7 @@ Defines the location of the temporary build directories.
.br
Defaults to /var/tmp.
-This should not be set to point anywhere under the directory tree
-specified by \fBPORTDIR\fR (/usr/portage by default).
+This should not be set to point anywhere under location of any repository.
.TP
\fBPORTAGE_USERNAME\fR = \fI[user]\fR
Defines the username to use when executing in userpriv/etc... modes (i.e.
@@ -926,8 +925,8 @@ when \fBxattr\fR is in \fBFEATURES\fR.
Defaults to "security.*" (security labels are special, see bug #461868).
.TP
\fBPORTDIR\fR = \fI[path]\fR
-Defines the location of the Portage tree. This is the repository for all
-profile information as well as all ebuilds. If you change this, you must update
+Defines the location of main repository. This variable is deprecated in favor of
+settings in \fBrepos.conf\fR. If you change this, you must update
your /etc/portage/make.profile symlink accordingly.
.br
Defaults to /usr/portage.
@@ -943,8 +942,8 @@ put other data (such as overlays) in your \fBPORTDIR\fB. Portage will walk
directory structures and may arbitrarily add invalid categories as packages.
.TP
\fBPORTDIR_OVERLAY\fR = \fI"[path] [different\-path] [etc...]"\fR
-Defines the directories in which user made ebuilds may be stored and not
-overwriten when `emerge \-\-sync` is run. This is a space delimited list of
+Defines the locations of other repositories. This variable is deprecated in
+favor of settings in \fBrepos.conf\fR. This variable is a space\-delimited list of
directories.
.br
Defaults to no value.
@@ -994,7 +993,7 @@ Defaults to /.
\fBRPMDIR\fR = \fI[path]\fR
Defines the location where created RPM packages will be stored.
.br
-Defaults to ${PORTDIR}/rpm.
+Defaults to /usr/portage/rpm.
.TP
\fBSYNC\fR = \fI[RSYNC]\fR
Insert your preferred rsync mirror here. This rsync server
diff --git a/man/portage.5 b/man/portage.5
index bfe4af87b..ad801ba59 100644
--- a/man/portage.5
+++ b/man/portage.5
@@ -1,4 +1,4 @@
-.TH "PORTAGE" "5" "Dec 2013" "Portage VERSION" "Portage"
+.TH "PORTAGE" "5" "Jan 2014" "Portage VERSION" "Portage"
.SH NAME
portage \- the heart of Gentoo
.SH "DESCRIPTION"
@@ -146,8 +146,7 @@ configuration files and command line arguments for programs such as
Atoms with repository constraints have a '::' separator appended to the
right side, followed by a repository name. Each repository name should
correspond to the value of a \fBrepo_name\fR entry from one of the
-repositories that is configured via the \fBPORTDIR\fR or
-\fBPORTDIR_OVERLAY\fR variables (see \fBmake.conf\fR(5)).
+repositories that is configured in \fBrepos.conf\fR file.
.I Examples:
.nf
@@ -224,8 +223,8 @@ portage-2.1.6.7, and it is not included in PMS at this time.
.I Example:
.nf
-${PORTDIR}/profiles/package.mask/removals
-${PORTDIR}/profiles/package.mask/testing
+${repository_location}/profiles/package.mask/removals
+${repository_location}/profiles/package.mask/testing
.fi
.RS
.TP
@@ -550,9 +549,8 @@ any other bash script.
Additional package-specific bashrc files can be created in /etc/portage/env.
.TP
.BR categories
-A simple list of valid categories that may be used in /usr/portage,
-PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)). This allows for custom
-categories to be created.
+A simple list of valid categories that may be used in repositories and PKGDIR
+(see \fBmake.conf\fR(5)). This allows for custom categories to be created.
.I Format:
.nf
@@ -611,7 +609,7 @@ After changing the portdbapi.auxdbmodule setting, it may be necessary to
transfer or regenerate metadata cache. Users of the rsync tree need to
run `emerge \-\-metadata` if they have enabled FEATURES="metadata-transfer"
in \fBmake.conf\fR(5). In order to regenerate metadata for repositories
-listed in \fBPORTDIR_OVERLAY\fR or a cvs tree, run `emerge \-\-regen`
+not distributing pregenerated metadata cache, run `emerge \-\-regen`
(see \fBemerge\fR(1)). If you use something like the sqlite module and want
to keep all metadata in that format alone (useful for querying), enable
FEATURES="metadata-transfer" in \fBmake.conf\fR(5).
@@ -859,7 +857,7 @@ Specifies CVS repository.
.B sync\-type
Specifies type of synchronization performed by `emerge \-\-sync`.
.br
-Valid non-empty values: cvs, git, rsync
+Valid non\-empty values: cvs, git, rsync
.br
This attribute can be set to empty value to disable synchronization of given
repository. Empty value is default.
@@ -1009,12 +1007,13 @@ List of EAPIs which are not allowed in this repo.
List of EAPIs which are allowed but generate warnings when used.
.TP
.BR masters
-Names of repositories which satisfy dependencies on eclasses and/or ebuilds. Each
-repository name should correspond the value of a \fBrepo_name\fR entry
-from one of the repositories that is configured via the \fBPORTDIR\fR or
-\fBPORTDIR_OVERLAY\fR variables (see \fBmake.conf\fR(5)). Repositories listed
-toward the right of the \fBmasters\fR list take precedence over those listed
-toward the left of the list.
+Names of repositories which satisfy dependencies on eclasses and from which
+settings specified in various repository\-level files (\fBpackage.mask\fR,
+\fBpackage.use.mask\fR, \fBuse.mask\fR etc.) are inherited. Each repository
+name should correspond to the value of a \fBrepo_name\fR entry from one of
+the repositories that is configured in \fBrepos.conf\fR file. Repositories
+listed toward the right of the \fBmasters\fR list take precedence over those
+listed toward the left of the list.
.TP
.BR repo\-name " = <value of profiles/repo_name>"
The name of this repository (overrides profiles/repo_name if it exists).
@@ -1131,8 +1130,8 @@ sparc
.fi
.TP
.BR categories
-A simple list of valid categories that may be used in /usr/portage,
-PORTDIR_OVERLAY, and PKGDIR (see \fBmake.conf\fR(5)).
+A simple list of valid categories that may be used in repositories and PKGDIR
+(see \fBmake.conf\fR(5)).
.I Format:
.nf