Gentoo Archives: gentoo-dev

From: Thomas Bracht Laumann Jespersen <t@×××××××.xyz>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [PATCH] linux-info.eclass: Documentation updates
Date: Mon, 16 May 2022 19:10:13
Message-Id: 20220516190956.6rzqgpmth7evycov@sofaking
In Reply to: [gentoo-dev] [PATCH] linux-info.eclass: Documentation updates by Mike Pagano
1 > +# @FUNCTION: qout
2 > +# @DESCRIPTION:
3 > +# qout <einfo | ewarn | eerror> is a quiet call when EBUILD_PHASE
4 > # should not have visible output.
5
6 The devmanual says that @USAGE is also required for eclass functions [0]. This
7 is applicable in a few cases, I'm just highlighting one here.
8
9 OTOH lots of eclass functions have left out @USAGE, and the tooling around
10 html/man page generation also appears to treat it as optional. So it could be
11 that the devmanual is wrong here.
12
13 -- Thomas
14
15 [0]: https://devmanual.gentoo.org/eclass-writing/index.html#eclass-functions

Replies