Gentoo Archives: gentoo-dev

From: Ulrich Mueller <ulm@g.o>
To: gentoo-dev@l.g.o
Subject: Re: [gentoo-dev] tagging deprecated eclasses internally
Date: Sat, 26 Sep 2020 11:23:33
Message-Id: uv9g0srx6@gentoo.org
In Reply to: [gentoo-dev] tagging deprecated eclasses internally by Tim Harder
1 >>>>> On Thu, 24 Sep 2020, Tim Harder wrote:
2
3 > In short, pkgcheck (in git) now supports parsing the eclass doc format
4 > as specified at [1] for the gentoo repo. This enables extracting more
5 > info from various eclass doc annotations.
6
7 > Along those lines, pkgcheck recognizes the '@DEPRECATED:' tag for all
8 > eclass doc block types. At the global level, this allows deprecated
9 > eclasses to internally document their status inside the '@ECLASS:'
10 > block, note their replacement (if any), and add further information if
11 > necessary.
12
13 > This allows for the hardcoded and poorly maintained eclass deprecation
14 > list in pkgcheck to be replaced by a dynamic version pulled from its
15 > eclass cache.
16
17 > If no one objects, I'd like to replace the deprecated-eclass section in
18 > metadata/qa-policy.conf with individual '@DEPRECATED:' annotations for
19 > the listed eclasses as well as adding info about the tag to the
20 > devmanual.
21
22 IIUC the authoritative document for eclass documentation is the
23 description of the format in the eclass-to-manpage.awk script, so this
24 would be a good start to add support for a new tag.
25
26 The devmanual only follows suit, and obviously cannot mention any tags
27 that aren't supported in man page conversion.
28
29 Ulrich

Attachments

File name MIME type
signature.asc application/pgp-signature

Replies

Subject Author
Re: [gentoo-dev] tagging deprecated eclasses internally Tim Harder <radhermit@g.o>