| 1 |
On 12/12/2016 09:49 PM, Mike Gilbert wrote: |
| 2 |
> On Mon, Dec 12, 2016 at 9:44 PM, Mike Gilbert <floppym@g.o> wrote: |
| 3 |
>> On Mon, Dec 12, 2016 at 7:34 PM, Mike Pagano <mpagano@g.o> wrote: |
| 4 |
>>> According to PMS, @USAGE is required for functions. |
| 5 |
>>> This patch only touches comments and no code has been modified. |
| 6 |
>> |
| 7 |
>> PMS says nothing on the topic of eclass documentation syntax. |
| 8 |
>> |
| 9 |
>> Any requirements are imposed by the eclass-manpages awk script. |
| 10 |
> |
| 11 |
> Maybe you were referring to the devmanual (not PMS)? |
| 12 |
> |
| 13 |
> https://devmanual.gentoo.org/eclass-writing/index.html |
| 14 |
> |
| 15 |
> Personally, I don't think it makes sense to add an empty @USAGE entry |
| 16 |
> for functions that take no arguments. |
| 17 |
> |
| 18 |
|
| 19 |
You're absolutely right, Mike. It was the devmanual. |
| 20 |
|
| 21 |
I'm not a fan of having an empty usage. As the devmanual is written |
| 22 |
today, it is not optional. |
| 23 |
|
| 24 |
I'll leave them in for now, and if the devmanual gets updated, I'll |
| 25 |
remove them. |
| 26 |
|
| 27 |
-- |
| 28 |
Mike Pagano |
| 29 |
Gentoo Developer - Kernel Project |
| 30 |
Gentoo Sources - Lead |
| 31 |
E-Mail : mpagano@g.o |
| 32 |
GnuPG FP : 52CC A0B0 F631 0B17 0142 F83F 92A6 DBEC 81F2 B137 |
| 33 |
Public Key : |
| 34 |
http://http://pgp.mit.edu/pks/lookup?search=0x92A6DBEC81F2B137&op=index |
Archives