[prev in list] [next in list] [prev in thread] [next in thread] 

List:       gentoo-dev
Subject:    Re: [gentoo-dev] tagging deprecated eclasses internally
From:       Ulrich Mueller <ulm () gentoo ! org>
Date:       2020-09-26 11:23:17
Message-ID: uv9g0srx6 () gentoo ! org
[Download RAW message or body]


>>>>> On Thu, 24 Sep 2020, Tim Harder wrote:

> In short, pkgcheck (in git) now supports parsing the eclass doc format
> as specified at [1] for the gentoo repo. This enables extracting more
> info from various eclass doc annotations.

> Along those lines, pkgcheck recognizes the '@DEPRECATED:' tag for all
> eclass doc block types. At the global level, this allows deprecated
> eclasses to internally document their status inside the '@ECLASS:'
> block, note their replacement (if any), and add further information if
> necessary.  

> This allows for the hardcoded and poorly maintained eclass deprecation
> list in pkgcheck to be replaced by a dynamic version pulled from its
> eclass cache.

> If no one objects, I'd like to replace the deprecated-eclass section in
> metadata/qa-policy.conf with individual '@DEPRECATED:' annotations for
> the listed eclasses as well as adding info about the tag to the
> devmanual.

IIUC the authoritative document for eclass documentation is the
description of the format in the eclass-to-manpage.awk script, so this
would be a good start to add support for a new tag.

The devmanual only follows suit, and obviously cannot mention any tags
that aren't supported in man page conversion.

Ulrich

["signature.asc" (application/pgp-signature)]

[prev in list] [next in list] [prev in thread] [next in thread]