diff options
| author |   Sam James <sam@gentoo.org> | 2021-03-22 06:56:29 +0000 |
|---|---|---|
| committer |   Ulrich Müller <ulm@gentoo.org> | 2021-03-30 08:53:26 +0200 |
| commit | 336d16aa5fe8c564a15760659e1670a0e98e58b3 (patch) | |
| tree | e5e53af0ec4a9ca2cfd9d0fd8a31f55851f03bde /eclass-writing | |
| parent | eclass-writing: add new eclass doc tags for Eclass Functions (diff) | |
| download | devmanual-336d16aa5fe8c564a15760659e1670a0e98e58b3.tar.gz devmanual-336d16aa5fe8c564a15760659e1670a0e98e58b3.tar.bz2 devmanual-336d16aa5fe8c564a15760659e1670a0e98e58b3.zip | |
eclass-writing: add new eclass doc tags for Eclass Function Variables
Adds:
* @USER_VARIABLE
* @INCLUDES_EPREFIX
* @DEPRECATED
Signed-off-by: Sam James <sam@gentoo.org>
Signed-off-by: Ulrich Müller <ulm@gentoo.org>
Diffstat (limited to 'eclass-writing')
| -rw-r--r-- | eclass-writing/text.xml | 90 |
1 files changed, 39 insertions, 51 deletions
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml index 5a1015f..e8b1474 100644 --- a/eclass-writing/text.xml +++ b/eclass-writing/text.xml @@ -568,12 +568,8 @@ using the following tags: <th>description</th> </tr> <tr> - <ti> - <c>@VARIABLE:</c> - </ti> - <ti> - NO - </ti> + <ti><c>@VARIABLE:</c></ti> + <ti>NO</ti> <ti> Name of the function-specific variable to which the documentation applies. </ti> @@ -584,61 +580,53 @@ using the following tags: </ti> </tr> <tr> - <ti> - <c>@DEFAULT_UNSET</c> - </ti> - <ti> - YES - </ti> - <ti> - <d/> - </ti> + <ti><c>@USER_VARIABLE</c></ti> + <ti>YES</ti> + <ti><d/></ti> + <ti> + This tag describes whether the variable is unsuitable for use in ebuilds, + i.e. if it is solely for user consumption via e.g. make.conf or a similar + mechanism. + </ti> +</tr> +<tr> + <ti><c>@DEFAULT_UNSET</c></ti> + <ti>YES</ti> + <ti><d/></ti> <ti> Indicates that this variable is unset by default if not set by the developer. </ti> </tr> <tr> - <ti> - <c>@INTERNAL</c> - </ti> - <ti> - YES - </ti> - <ti> - <d/> - </ti> - <ti> - Indicates that the variable is internal to the eclass function. - </ti> + <ti><c>@INCLUDES_EPREFIX</c></ti> + <ti>YES</ti> + <ti><d/></ti> + <ti>Indicates that the variable is a path which has ${EPREFIX} prepended.</ti> </tr> <tr> - <ti> - <c>@REQUIRED</c> - </ti> - <ti> - YES - </ti> - <ti> - <d/> - </ti> - <ti> - Indicates that this variable must be set by the developer. - </ti> + <ti><c>@INTERNAL</c></ti> + <ti>YES</ti> + <ti><d/></ti> + <ti>Indicates that the variable is internal to the eclass function.</ti> </tr> <tr> - <ti> - <c>@DESCRIPTION:</c> - </ti> - <ti> - NO - </ti> - <ti> - Multiline freetext. - </ti> - <ti> - Long description for the function variable. - </ti> + <ti><c>@REQUIRED</c></ti> + <ti>YES</ti> + <ti><d/></ti> + <ti>Indicates that this variable must be set by the developer.</ti> +</tr> +<tr> + <ti><c>@DEPRECATED</c></ti> + <ti>YES</ti> + <ti>Optionally, the name of any replacement variable.</ti> + <ti>Declares that this variable should no longer be used in ebuilds.</ti> +</tr> +<tr> + <ti><c>@DESCRIPTION:</c></ti> + <ti>NO</ti> + <ti>Multiline freetext.</ti> + <ti>Long description for the function variable.</ti> </tr> </table> |