| 1 |
>>>>> On Mon, 16 May 2022, Thomas Bracht Laumann Jespersen wrote: |
| 2 |
|
| 3 |
>> +# @FUNCTION: qout |
| 4 |
>> +# @DESCRIPTION: |
| 5 |
>> +# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE |
| 6 |
>> # should not have visible output. |
| 7 |
|
| 8 |
> The devmanual says that @USAGE is also required for eclass functions |
| 9 |
> [0]. This is applicable in a few cases, I'm just highlighting one |
| 10 |
> here. |
| 11 |
|
| 12 |
@USAGE is required if the function accepts any arguments. This is |
| 13 |
similar to @RETURN, and is clear from the examples in [0]. For example, |
| 14 |
jmake_src_compile at the bottom of the page doesn't have a @USAGE line. |
| 15 |
|
| 16 |
> OTOH lots of eclass functions have left out @USAGE, and the tooling |
| 17 |
> around html/man page generation also appears to treat it as optional. |
| 18 |
|
| 19 |
Which is correct AFAICS. |
| 20 |
|
| 21 |
> So it could be that the devmanual is wrong here. |
| 22 |
|
| 23 |
> [0]: https://devmanual.gentoo.org/eclass-writing/index.html#eclass-functions |
Archives