Gentoo Archives: gentoo-dev

From: Chris Mayo <aklhfex@×××××.com>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed
Date: Wed, 06 Sep 2017 18:39:37
Message-Id: fa18a282-4ab3-081c-139f-ce995cf2f51d@gmail.com
In Reply to: Re: [gentoo-dev] [PATCH] eutils.eclass: Document optfeature suggests packages not installed by Michael Orlitzky
1 On 03/09/17 22:22, Michael Orlitzky wrote:
2 > On 09/03/2017 11:56 AM, Chris Mayo wrote:
3 >> #
4 >> # The following snippet would suggest app-misc/foo for optional foo support,
5 >> # app-misc/bar or app-misc/baz[bar] for optional bar support
6 >>
7 >
8 > Would the @EXAMPLE tag[0] make sense here?
9 >
10 >
11 > [0] https://devmanual.gentoo.org/eclass-writing/index.html
12 >
13
14 I believe @EXAMPLE is only for the first documentation block introducing the eclass.
15
16 At least where it is used for functions the text doesn't show up in the man page.
17 e.g. prefix.eclass hprefixify() and prefixify_ro()
18
19 https://devmanual.gentoo.org/eclass-reference/prefix.eclass/index.html
20
21 https://gitweb.gentoo.org/repo/gentoo.git/tree/eclass/prefix.eclass?id=61b861acd7b49083dab687e133f30f3331cb7480

Replies