1 |
commit: 606491574fd91b65447b4376b2b21bf092749a64 |
2 |
Author: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
3 |
AuthorDate: Tue Oct 24 08:48:09 2017 +0000 |
4 |
Commit: Ulrich Müller <ulm <AT> gentoo <DOT> org> |
5 |
CommitDate: Tue Oct 24 10:33:50 2017 +0000 |
6 |
URL: https://gitweb.gentoo.org/proj/portage.git/commit/?id=60649157 |
7 |
|
8 |
man/ebuild.5: Do not document internal functions. |
9 |
|
10 |
Functions containing "hook" or "prep" in their name may not be used |
11 |
or relied upon by ebuilds. Therefore they should not be documented |
12 |
in ebuild(5) which describes the funtions available for ebuilds. |
13 |
|
14 |
PMS reference: https://projects.gentoo.org/pms/6/pms.html#x1-14700011.3.3.16 |
15 |
|
16 |
Acked-by: Zac Medico <zmedico <AT> gentoo.org> |
17 |
|
18 |
man/ebuild.5 | 76 +----------------------------------------------------------- |
19 |
1 file changed, 1 insertion(+), 75 deletions(-) |
20 |
|
21 |
diff --git a/man/ebuild.5 b/man/ebuild.5 |
22 |
index 43d12765d..42a0599fe 100644 |
23 |
--- a/man/ebuild.5 |
24 |
+++ b/man/ebuild.5 |
25 |
@@ -1,4 +1,4 @@ |
26 |
-.TH "EBUILD" "5" "Nov 2014" "Portage VERSION" "Portage" |
27 |
+.TH "EBUILD" "5" "Oct 2017" "Portage VERSION" "Portage" |
28 |
|
29 |
.SH "NAME" |
30 |
ebuild \- the internal format, variables, and functions in an ebuild script |
31 |
@@ -1104,16 +1104,6 @@ Example: |
32 |
installed) |
33 |
.fi |
34 |
|
35 |
-.SS "Hooks:" |
36 |
-.TP |
37 |
-.B register_die_hook\fR \fI[list of function names] |
38 |
-Register one or more functions to call when the ebuild fails for any reason, |
39 |
-including file collisions with other packages. |
40 |
-.TP |
41 |
-.B register_success_hook\fR \fI[list of function names] |
42 |
-Register one or more functions to call when the ebuild builds and/or installs |
43 |
-successfully. |
44 |
- |
45 |
.SS "Output:" |
46 |
.TP |
47 |
.B einfo\fR \fI"disposable message" |
48 |
@@ -1225,70 +1215,6 @@ Please do \fBnot\fR use this in place of 'emake install DESTDIR=${D}'. |
49 |
That is the preferred way of installing make\-based packages. Also, do |
50 |
not utilize the \fIEXTRA_EINSTALL\fR variable since it is for users. |
51 |
|
52 |
-.PD 0 |
53 |
-.TP |
54 |
-.B prepall |
55 |
-.TP |
56 |
-.B prepalldocs |
57 |
-.TP |
58 |
-.B prepallinfo |
59 |
-.TP |
60 |
-.B prepallman |
61 |
-.TP |
62 |
-.B prepallstrip |
63 |
-.PD 1 |
64 |
-Useful for when a package installs into \fB${D}\fR via scripts |
65 |
-(i.e. makefiles). If you want to be sure that libraries are executable, |
66 |
-aclocal files are installed into the right place, doc/info/man files are |
67 |
-all compressed, and that executables are all stripped of debugging symbols, |
68 |
-then use these suite of functions. |
69 |
-.RS |
70 |
-.PD 0 |
71 |
-.TP |
72 |
-.B prepall: |
73 |
-Runs \fBprepallman\fR, \fBprepallinfo\fR, \fBprepallstrip\fR, sets |
74 |
-libraries +x, and then checks aclocal directories. Please note this |
75 |
-does \fI*not*\fR run \fBprepalldocs\fR. |
76 |
-.TP |
77 |
-.B prepalldocs: |
78 |
-Compresses all doc files in ${ED}/usr/share/doc. |
79 |
-.TP |
80 |
-.B prepallinfo: |
81 |
-Compresses all info files in ${ED}/usr/share/info. |
82 |
-.TP |
83 |
-.B prepallman: |
84 |
-Compresses all man files in ${ED}/usr/share/man. |
85 |
-.TP |
86 |
-.B prepallstrip: |
87 |
-Strips all executable files of debugging symboles. This includes libraries. |
88 |
-.RE |
89 |
- |
90 |
-.TP |
91 |
-.B prepinfo\fR \fI[dir] |
92 |
-.TP |
93 |
-.B prepman\fR \fI[dir] |
94 |
-.TP |
95 |
-.B prepstrip\fR \fI[dir] |
96 |
-.PD 1 |
97 |
-Similar to the \fBprepall\fR functions, these are subtle in their differences. |
98 |
-.RS |
99 |
-.PD 0 |
100 |
-.TP |
101 |
-.B prepinfo: |
102 |
-If a \fIdir\fR is not specified, then \fBprepinfo\fR will assume the dir |
103 |
-\fIusr\fR. \fBprepinfo\fR will then compress all the files in |
104 |
-${ED}/\fIdir\fR/info. |
105 |
-.TP |
106 |
-.B prepman: |
107 |
-If a \fIdir\fR is not specified, then \fBprepman\fR will assume the dir |
108 |
-\fIusr\fR. \fBprepman\fR will then compress all the files in |
109 |
-${ED}/\fIdir\fR/man/*/. |
110 |
-.TP |
111 |
-.B prepstrip: |
112 |
-All the files found in ${ED}/\fIdir\fR will be stripped. You may specify |
113 |
-multiple directories. |
114 |
-.RE |
115 |
-.PD 1 |
116 |
.TP |
117 |
.B docompress\fR \fI[\-x] <path> [list of more paths] |
118 |
.RS |