Gentoo Archives: gentoo-dev

From: Mike Gilbert <floppym@g.o>
To: Gentoo Dev <gentoo-dev@l.g.o>
Subject: Re: [gentoo-dev] [PATCH 1/1] kernel-2.eclass: Add required @USAGE documentation to functions.
Date: Tue, 13 Dec 2016 02:50:09
Message-Id: CAJ0EP43AszT0+w4XTNC46YD56Y-KLbEWd3nM=X_p55E-1oOY3w@mail.gmail.com
In Reply to: Re: [gentoo-dev] [PATCH 1/1] kernel-2.eclass: Add required @USAGE documentation to functions. by Mike Gilbert
1 On Mon, Dec 12, 2016 at 9:44 PM, Mike Gilbert <floppym@g.o> wrote:
2 > On Mon, Dec 12, 2016 at 7:34 PM, Mike Pagano <mpagano@g.o> wrote:
3 >> According to PMS, @USAGE is required for functions.
4 >> This patch only touches comments and no code has been modified.
5 >
6 > PMS says nothing on the topic of eclass documentation syntax.
7 >
8 > Any requirements are imposed by the eclass-manpages awk script.
9
10 Maybe you were referring to the devmanual (not PMS)?
11
12 https://devmanual.gentoo.org/eclass-writing/index.html
13
14 Personally, I don't think it makes sense to add an empty @USAGE entry
15 for functions that take no arguments.

Replies