public inbox for gentoo-dev@lists.gentoo.org
 help / color / mirror / Atom feed
From: Tim Harder <radhermit@gentoo.org>
To: gentoo-dev@lists.gentoo.org
Subject: [gentoo-dev] tagging deprecated eclasses internally
Date: Wed, 23 Sep 2020 18:06:37 -0600	[thread overview]
Message-ID: <20200924000637.GA6343@fir> (raw)

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.

Tim

[1]: https://devmanual.gentoo.org/eclass-writing/#documenting-eclasses


             reply	other threads:[~2020-09-24  0:06 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-24  0:06 Tim Harder [this message]
2020-09-26 11:23 ` [gentoo-dev] tagging deprecated eclasses internally Ulrich Mueller
2020-10-10 20:58   ` Tim Harder

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200924000637.GA6343@fir \
    --to=radhermit@gentoo.org \
    --cc=gentoo-dev@lists.gentoo.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox