diff options
author | Zac Medico <zmedico@gentoo.org> | 2010-12-30 15:50:31 -0800 |
---|---|---|
committer | Zac Medico <zmedico@gentoo.org> | 2010-12-30 15:50:31 -0800 |
commit | 159b57d0d21b6767e7e1787761761f906613d600 (patch) | |
tree | 4254faf64b85f69d1c95cb12de2d46904dc2aa3b | |
parent | 5da66e02d59ba75d769f1061ef5ae27561c96c2a (diff) | |
download | portage-159b57d0d21b6767e7e1787761761f906613d600.tar.gz portage-159b57d0d21b6767e7e1787761761f906613d600.tar.bz2 portage-159b57d0d21b6767e7e1787761761f906613d600.zip |
ebuild(5): new docompress helper in EAPI 4
-rw-r--r-- | man/ebuild.5 | 39 |
1 files changed, 39 insertions, 0 deletions
diff --git a/man/ebuild.5 b/man/ebuild.5 index dd4e921cf..8c9ee61c4 100644 --- a/man/ebuild.5 +++ b/man/ebuild.5 @@ -923,6 +923,45 @@ multiple directories. .RE .PD 1 .TP +\fBdocompress\fR \fI[-x] <path> [list of more paths]\fR +.RS +Beginning with \fBEAPI 4\fR, the \fBdocompress\fR helper is used to +manage lists of files to be included or excluded from optional compression. +If the first argument is \fB-x\fR, add each of its subsequent arguments to +the exclusion list. Otherwise, add each argument to the inclusion list. +The inclusion list initially contains \fI/usr/share/doc\fR, +\fI/usr/share/info\fR, and \fI/usr/share/man\fR. The exclusion list +initially contains \fI/usr/share/doc/${PF}/html\fR. + +The optional compression shall be carried out after \fBsrc_install\fR +has completed, and before the execution of any subsequent phase +function. For each item in the inclusion list, pretend it has the +value of the \fBD\fR variable prepended, then: + +.RS +If it is a directory, act as if every file or directory immediately +under this directory were in the inclusion list. + +If the item is a file, it may be compressed unless it has been +excluded as described below. + +If the item does not exist, it is ignored. +.RE + +Whether an item is to be excluded is determined as follows: For each +item in the exclusion list, pretend it has the value of the \fBD\fR +variable prepended, then: + +.RS +If it is a directory, act as if every file or directory immediately +under this directory were in the exclusion list. + +If the item is a file, it shall not be compressed. + +If the item does not exist, it is ignored. +.RE +.RE +.TP \fBdosed\fR \fI"s:orig:change:g" <filename>\fR Beginning with \fBEAPI 4\fR, the \fBdosed\fR helper no longer exists. Ebuilds should call \fBsed(1)\fR directly (and assume that it is GNU sed). |