all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Vasilij Schneidermann <mail@vasilij.de>
To: emacs-devel@gnu.org
Subject: Obtaining a database of new functionality per Emacs version
Date: Mon, 7 Dec 2020 13:23:29 +0100	[thread overview]
Message-ID: <X84ewTWkQRrdHJhK@odonien.localdomain> (raw)

[-- Attachment #1: Type: text/plain, Size: 1688 bytes --]

Hello everyone,

I'm looking into creating a tool helping me with ensuring that my
packages actually support the Emacs versions they claim to by
highlighting uses of unsupported functions/variables [1]. For example if
I were to commit myself on supporting Debian stable with its Emacs 26.1,
that tool would highlight uses of `with-suppressed-warnings`, a macro
introduced in Emacs 27.1. The first problem to tackle is that there
doesn't seem to be a ready-made database. I've identified the following
options for making my own:

- Relying on metadata from custom.el: Works on customizables only.
- Combing through NEWS files: Not machine-readable, tedious, prone to
  mistakes (not all new functionality is marked as such, for example
  there's renames like `with-connection-local-profiles` to
  `with-connection-local-variables`).
- Combing through CHANGELOG: Not machine-readable either, tedious, not
  cleanly separated by versions, seemingly the wrong data source to
  consult.
- Launching an Emacs process, loading up all functionality, dumping all
  symbols, diffing against the output of an Emacs process of an older
  version, filtering out symbols introduced by our own code: This might
  just work (loading up functionality has side effects), but surely
  there's a better way, right?

Anything obvious I'm overlooking? Should there perhaps be an effort
towards documenting versioned public API?

Vasilij

[1]: I realize that this is far from solving the whole problem as
incorrect uses might still slip through, for example APIs taking a
different amount of arguments. To detect these, CI is required. However
I believe there is still merit to a tool run before CI kicks in...

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]

             reply	other threads:[~2020-12-07 12:23 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-12-07 12:23 Vasilij Schneidermann [this message]
2020-12-07 15:19 ` Obtaining a database of new functionality per Emacs version Stefan Monnier
2020-12-07 18:11   ` Vasilij Schneidermann
2020-12-07 18:20     ` Eli Zaretskii
2020-12-07 19:54     ` Stefan Monnier
2020-12-07 15:34 ` Eli Zaretskii
2020-12-07 17:50   ` Vasilij Schneidermann
2020-12-07 18:17     ` Eli Zaretskii
2020-12-07 20:08       ` Stefan Monnier
2020-12-07 20:25         ` Eli Zaretskii
2020-12-07 20:40           ` Stefan Monnier
2020-12-10  7:31 ` Jean Louis
2020-12-10 14:14   ` Eli Zaretskii
2020-12-10 16:47     ` Stefan Monnier
2020-12-10 17:22       ` Vasilij Schneidermann
2020-12-10 17:59         ` Stefan Monnier

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=X84ewTWkQRrdHJhK@odonien.localdomain \
    --to=mail@vasilij.de \
    --cc=emacs-devel@gnu.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.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.