1 |
commit: b80285bdc37a51a2628bf4b7edd44717c15062cb |
2 |
Author: Sam James <sam <AT> gentoo <DOT> org> |
3 |
AuthorDate: Mon Mar 22 06:44:06 2021 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Tue Mar 30 06:53:26 2021 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/devmanual.git/commit/?id=b80285bd |
7 |
|
8 |
eclass-writing: add new eclass doc tags for Eclass Functions |
9 |
|
10 |
Adds: |
11 |
* @INCLUDES_EPREFIX |
12 |
* @DEPRECATED |
13 |
|
14 |
Signed-off-by: Sam James <sam <AT> gentoo.org> |
15 |
Signed-off-by: Ulrich Müller <ulm <AT> gentoo.org> |
16 |
|
17 |
eclass-writing/text.xml | 23 ++++++++++++++++------- |
18 |
1 file changed, 16 insertions(+), 7 deletions(-) |
19 |
|
20 |
diff --git a/eclass-writing/text.xml b/eclass-writing/text.xml |
21 |
index b7fd988..5a1015f 100644 |
22 |
--- a/eclass-writing/text.xml |
23 |
+++ b/eclass-writing/text.xml |
24 |
@@ -508,20 +508,29 @@ documentation are: |
25 |
</ti> |
26 |
</tr> |
27 |
<tr> |
28 |
+ <ti><c>@INCLUDES_EPREFIX</c></ti> |
29 |
+ <ti>YES</ti> |
30 |
+ <ti><d/></ti> |
31 |
<ti> |
32 |
- <c>@INTERNAL</c> |
33 |
- </ti> |
34 |
- <ti> |
35 |
- YES |
36 |
- </ti> |
37 |
- <ti> |
38 |
- <d/> |
39 |
+ Indicates whether the function returns a path with ${EPREFIX} prepended |
40 |
+ to it. |
41 |
</ti> |
42 |
+</tr> |
43 |
+<tr> |
44 |
+ <ti><c>@INTERNAL</c></ti> |
45 |
+ <ti>YES</ti> |
46 |
+ <ti><d/></ti> |
47 |
<ti> |
48 |
Indicates that the function is internal to the eclass and should |
49 |
not be called from outside. |
50 |
</ti> |
51 |
</tr> |
52 |
+<tr> |
53 |
+ <ti><c>@DEPRECATED</c></ti> |
54 |
+ <ti>YES</ti> |
55 |
+ <ti>Optionally, the name of a replacement function.</ti> |
56 |
+ <ti>Declares that this function should no longer be used in ebuilds.</ti> |
57 |
+</tr> |
58 |
<tr> |
59 |
<ti> |
60 |
<c>@DESCRIPTION:</c> |