Archives
Archives
| From: | Zac Medico <zmedico@g.o> | ||
|---|---|---|---|
| To: | gentoo-portage-dev@l.g.o, "Ulrich Müller" <ulm@g.o> | ||
| Subject: | Re: [gentoo-portage-dev] [PATCH] man/ebuild.5: Do not document internal functions. | ||
| Date: | Tue, 24 Oct 2017 09:53:50 | ||
| Message-Id: | 1c254d72-f26e-835a-d6c5-aabfd234e19f@gentoo.org | ||
| In Reply to: | [gentoo-portage-dev] [PATCH] man/ebuild.5: Do not document internal functions. by "Ulrich Müller" |
||
| 1 | On 10/24/2017 01:48 AM, Ulrich Müller wrote: |
| 2 | > Functions containing "hook" or "prep" in their name may not be used |
| 3 | > or relied upon by ebuilds. Therefore they should not be documented |
| 4 | > in ebuild(5) which describes the funtions available for ebuilds. |
| 5 | > |
| 6 | > PMS reference: https://projects.gentoo.org/pms/6/pms.html#x1-14700011.3.3.16 |
| 7 | > --- |
| 8 | > man/ebuild.5 | 76 +----------------------------------------------------------- |
| 9 | > 1 file changed, 1 insertion(+), 75 deletions(-) |
| 10 | |
| 11 | Looks good, please merge. |
| 12 | |
| 13 | I've added some separate documentation for register_die_hook and |
| 14 | register_success_hook in the bashrc documentation here: |
| 15 | |
| 16 | https://gitweb.gentoo.org/proj/portage.git/commit/?id=20dbb488cdb38da604fd54c3d09fd6709e13db6f |
| 17 | |
| 18 | -- |
| 19 | Thanks, |
| 20 | Zac |