Re: [gentoo-pms] EAPI Cheat Sheet: Sync with EAPI 4 of PMS

[Ulrich Mueller]

>>>>> On Mon, 20 Dec 2010, Christian Faulhammer wrote:

> Should I merge all patches in one or feature by feature?

I would commit everything at once, but I think that's really up to
you.

> Please review, they might have some rough edges still.

Thank you for all the work. See below for my comments.

>> \t{S} to \t{WORKDIR} fallback restricted

>  I fail to find a short description of the exact exceptions, so for
> now it just says: Fall back not there. How likely is it to hit the
> exception?

The conditions for an exception are described in subsection "Initial
Working Directories". All of these must be true:

 * The A variable contains no items.
 * The phase function in question is not in DEFINED_PHASES.
 * None of the phase functions unpack, prepare, configure, compile or
   install, if supported by the EAPI in question and occurring prior
   to the phase about to be executed, are in DEFINED_PHASES.

It more or less means "this is a virtual package".

> Subject: [PATCH 03/10] EAPI Cheat Sheet: Add PROPERTIES
> [...]
> +    \item[\code{PROPERTIES}] Is allowed for all package managers now
> +    to support interactive installs.

It's allowed already now (in all EAPIs), but in EAPI 4 support for
PROPERTIES is mandatory.

> Subject: [PATCH 07/10] EAPI Cheat Sheet: Describe MERGE_TYPE
> variable
> [...]
> +    \item[MERGE\_TYPE] This variable contains one of three possible
> +    values to allow checks for the purpose of the current run:
> +    \begin{description}
> +        \item[\code{source}] Building and installing a package from
> +        source.
> +        \item[\code{binary}] Installing a binary package.
> +        \item[\code{buildonly}] Building a binary package without installing it.
> +    \end{description}
> +    See \featureref{merge-type}.

This is a little long, but it's a matter of taste of course.

> Subject: [PATCH 09/10] EAPI Cheat Sheet: Describe REQUIRED_USE and pkg_required_use
> [...]
> +    \item[\code{REQUIRED\_USE}] This variable can be used similar to
> +    the \code{(R|P)DEPEND} variables and define sets of USE flag
> +    combinations that are not allowed.  All elements can be further
> +    nested to achieve more functionality.
> +    \begin{description}
> +        \item[Forbidden combination] To prevent activation of
> +        \code{flag1} if \code{flag2} is enabled use "\code{flag2? (
> +            !flag1 )}".
> +        \item[OR] If at least one USE flag out of many must be
> +        activated on \code{flag1} use "\code{flag1? || ( flag2 flag3
> +            \dots )}".
> +        \item[XOR] To allow exactly one USE flag out of many use
> +        "\code{\textasciicircum\textasciicircum ( flag1 flag2 \dots )}".
> +    \end{description}
> +    If those restrictions are violated by the user settings the
> +    \code{pkg\_required\_use} function is run, where advise can be
> +    given to the user how to set USE flags.  See
> +    \featureref{required-use}.

The pkg_required_use function was rejected by the council, so the
sentence immediately after the description list should be deleted.

BTW, I had the same problem as above, that neither \t{^^} nor \t{\^\^}
work in LaTeX. Does anybody know a shorter solution than
\t{\textasciicircum\textasciicircum}?

Ulrich