unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Bill Wohler <wohler@newt.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: bzg@altern.org, Stefan Kangas <stefan@marxist.se>, 13824@debbugs.gnu.org
Subject: bug#13824: 24.3.50; :package-version not taking priority over :version
Date: Sat, 10 Aug 2019 15:10:13 -0700	[thread overview]
Message-ID: <116969.1565475013@olgas.newt.com> (raw)
In-Reply-To: <83sgq98jet.fsf@gnu.org>

Eli Zaretskii <eliz@gnu.org> wrote:

> > From: Stefan Kangas <stefan@marxist.se>
> > Date: Thu, 8 Aug 2019 05:59:21 +0200
> > Cc: 13824@debbugs.gnu.org
> > 
> > Bastien Guerry <bzg@altern.org> writes:
> > 
> > > The docstring of `defcustom' says:
> > >
> > > :package-version
> > >         VALUE should be a list with the form (PACKAGE . VERSION)
> > >         specifying that the variable was first introduced, or its
> > >         default value was changed, in PACKAGE version VERSION.  This
> > >         keyword takes priority over :version.
> > >         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
> > >
> > > but `describe-variable-custom-version-info' gives priority to :version
> > > over :package-version.  Which one is correct here?
> > 
> > This is still an issue on current master (and 26.2).
> > 
> > I reproduced this using:
> > 
> >     (progn
> >       (defcustom foobar nil
> >         "foo"
> >         :version "27.1"
> >         :package-version '(foo . "1"))
> >       (describe-variable-custom-version-info 'foobar))
> > 
> > Which results in:
> > 
> >     "This variable was introduced, or its default value was changed, in
> >     version 27.1 of Emacs.
> >     "
> > 
> > But C-h f defcustom says:
> > 
> >     :package-version
> >             VALUE should be a list with the form (PACKAGE . VERSION)
> >             specifying that the variable was first introduced, or its
> >             default value was changed, in PACKAGE version VERSION.  This
> >             keyword takes priority over :version.
> 
> The implementation only prefers :package-version for the purposes of
> customize-changed-options, i.e. the Options->Customize Emacs->New
> Options menu item.  By contrast, describe-variable-custom-version-info
> is used for displaying the doc strings of options.  For a package that
> is bundled with Emacs, I think displaying :version in "C-h v" makes
> sense.  If people agree, then this is a minor documentation bug (also
> to be fixed in the ELisp manual), not a code bug.
> 
> Bill, what is your take on this?  Your change, which introduced this
> attribute, only modified customize-changed-options.  Was that on
> purpose?

Thanks for asking. The original intent of package-version was to provide
more accurate version information in packages that were updated more
often than Emacs, regardless of whether they were packaged in Emacs
(like MH-E and Gnus) or not. I think that should apply to any function
that displays version information for an option. That is, any function
that looks for :version should also look for :package-version.

-- 
Bill Wohler <wohler@newt.com> aka <Bill.Wohler@nasa.gov>
http://www.newt.com/wohler/, GnuPG ID:610BD9AD





  parent reply	other threads:[~2019-08-10 22:10 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-02-26 17:28 bug#13824: 24.3.50; :package-version not taking priority over :version Bastien Guerry
2019-08-08  3:59 ` Stefan Kangas
2019-08-10  9:22   ` Eli Zaretskii
2019-08-10 14:13     ` Stefan Kangas
2019-08-10 22:10     ` Bill Wohler [this message]
2019-08-10 22:40       ` Bill Wohler
2019-08-11 14:01       ` Eli Zaretskii
2019-08-11 18:06         ` Bill Wohler

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=116969.1565475013@olgas.newt.com \
    --to=wohler@newt.com \
    --cc=13824@debbugs.gnu.org \
    --cc=bzg@altern.org \
    --cc=eliz@gnu.org \
    --cc=stefan@marxist.se \
    /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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).