From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#66554: [PATCH] Add the public API of Compat to the core Date: Thu, 18 Jan 2024 22:17:43 +0200 Message-ID: <83v87qwg48.fsf@gnu.org> References: <87pm1ggrdx.fsf@posteo.net> <87bk9scucg.fsf@daniel-mendler.de> <87y1cwpanh.fsf@posteo.net> <877ckgpa45.fsf@daniel-mendler.de> <87mstbpyd7.fsf@posteo.net> <87h6jjah1g.fsf@daniel-mendler.de> <87edenptba.fsf@posteo.net> <87bk9raaad.fsf@daniel-mendler.de> <87a5pbvbxc.fsf@posteo.net> <875xzza8jw.fsf@daniel-mendler.de> <87edemldlw.fsf@posteo.net> <83cyu6ifzw.fsf@gnu.org> <875xzyl8lq.fsf@posteo.net> <837ckeievw.fsf@gnu.org> <87h6jiqtsp.fsf@daniel-mendler.de> <835xzyiagj.fsf@gnu.org> <871qamkx0m.fsf@posteo.net> <83wmsdhgw8.fsf@gnu.org> <87wmsdxvz6.fsf@daniel-mendler.de> <878r4ml8sg.fsf@posteo.net> Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="27648"; mail-complaints-to="usenet@ciao.gmane.io" Cc: mail@daniel-mendler.de, stefankangas@gmail.com, monnier@iro.umontreal.ca, 66554@debbugs.gnu.org To: Philip Kaludercic Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Thu Jan 18 21:19:31 2024 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1rQYrL-0006xU-Oi for geb-bug-gnu-emacs@m.gmane-mx.org; Thu, 18 Jan 2024 21:19:31 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rQYqs-0004TJ-8T; Thu, 18 Jan 2024 15:19:02 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rQYqq-0004T0-CE for bug-gnu-emacs@gnu.org; Thu, 18 Jan 2024 15:19:00 -0500 Original-Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1rQYqq-0003P0-3L for bug-gnu-emacs@gnu.org; Thu, 18 Jan 2024 15:19:00 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1rQYqr-0003GM-Qy for bug-gnu-emacs@gnu.org; Thu, 18 Jan 2024 15:19:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Thu, 18 Jan 2024 20:19:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 66554 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 66554-submit@debbugs.gnu.org id=B66554.170560908212462 (code B ref 66554); Thu, 18 Jan 2024 20:19:01 +0000 Original-Received: (at 66554) by debbugs.gnu.org; 18 Jan 2024 20:18:02 +0000 Original-Received: from localhost ([127.0.0.1]:56768 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rQYpu-0003Ev-5U for submit@debbugs.gnu.org; Thu, 18 Jan 2024 15:18:02 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:55028) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1rQYpq-0003EL-W5 for 66554@debbugs.gnu.org; Thu, 18 Jan 2024 15:18:00 -0500 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1rQYph-0003Gp-TT; Thu, 18 Jan 2024 15:17:49 -0500 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=gnu.org; s=fencepost-gnu-org; h=References:Subject:In-Reply-To:To:From:Date: mime-version; bh=p5lbroATQb3w6wkVULMJY5MelYj5Aap3PA1R0UAxAf4=; b=nylOFokLCBXY UGcsfGjWyi8rFUwyU3VJA0oPJx5rZa7nPemPrfiYVgB7X2r838bw7eSwLBDxclk9di+8iYc6VfRwH 3L5Idh/X1+tDMLXbLGZcjjcHkfKcxpKlSYtyqn+zDexGUCX195FYEuudXxcmdpCECh5Nc7wSba+jC +F+YsSw5IU1rewurpKoCOIsPsmB5aDrPbNGaqHJD0OPmawEJUhiNswQScM5h2LQKUiCCQD3ebSbS3 Jmo1sqFe4dh7B0L+n6yM6aQPk1QFtSS2J/W2fnK3l7DWODWQsOpJNso8YMgEkKmNhy2PpnTxuaW6h egR4eT9lDeheusmnv2HQjQ==; In-Reply-To: <878r4ml8sg.fsf@posteo.net> (message from Philip Kaludercic on Thu, 18 Jan 2024 19:51:27 +0000) X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:278448 Archived-At: > From: Philip Kaludercic > Cc: Eli Zaretskii , 66554@debbugs.gnu.org, > monnier@iro.umontreal.ca, stefankangas@gmail.com > Date: Thu, 18 Jan 2024 19:51:27 +0000 > > Pinging this thread with an updated version of the patch: I find the documentation of this arrangement still insufficient. The way this stuff works (which required Daniel to write 150 lines of explanation) is mostly kept out of the written docs, so we'll have to rely on people's memory. Can we document this machinery better? > +Packages that wish to support older releases of Emacs, without giving > +up on newer functionality from recent Emacs releases, one can make use > +of the Compat package on GNU ELPA. For details on how to make use of > +the package, @xref{Usage,, Usage, compat, "Compat" Manual}. In case ^^^^^ ^^ This should be "see @ref" or "@pxref". @xref is only suitable at the beginning of a statement. And please leave 2 spaces between sentences there. > +** New package Compat > +The Compat package on GNU ELPA provides forwards-compatibility > +support, so that packages that still provide support for older I think this is known as "backward compatibility". > +versions of Emacs can still make use of newer definitions that can be > +reasonably re-implemented in Elisp. Now a "pseudo" Compat package is > +part of Emacs, that doesn't provide any compatibility support, but > +only implements the public-facing API of Compat so that core packages > +can use Compat, while also preventing the installation of Compat on > +the most recent version of Emacs. Not sure this detailed description is useful. Why not just say that Compat is now also available with Emacs?