all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Stefan Kangas <stefankangas@gmail.com>
To: Philip Kaludercic <philipk@posteo.net>
Cc: emacs-devel@gnu.org, John Wiegley <johnw@gnu.org>
Subject: Re: use-package has been merged into emacs-29
Date: Sat, 10 Dec 2022 12:34:03 -0800	[thread overview]
Message-ID: <CADwFkmnJ6OaDQ-USm_Ddwd6_YVqcLGJ=Tcs6BFZWV==ZANBj6A@mail.gmail.com> (raw)
In-Reply-To: <878rjgd0ej.fsf@posteo.net>

Philip Kaludercic <philipk@posteo.net> writes:

> - It appears to be mentioning a few packages that are not available on
>   GNU ELPA or NonGNU ELPA (e.g. git-gutter+, eruby-mode, dash-at-point,
>   ess, color-moccur, moccur-edit, unfill).  Should they be replaced
>   with other packages to make sure the examples are consistently
>   reproducible?

Yup.  All examples like that come from the old README.md.  I got rid of
most of them, but there are several left to fix.

I think we should replace them with either some made up package name
(e.g. "foo" or "some-package") or, in order of preference: built-in, GNU
ELPA, NonGNU ELPA.

IMO, replacing NonGNU ELPA with GNU ELPA packages is usually an
improvement, and so is replacing GNU ELPA packages with built-in ones.

> - MELPA is mention under vindex `use-package-always-pin', is this ok.
>   AFAIR there was some decision to not mention MELPA in the official
>   documentation (currently this also appears to be the only instance).

It's only mentioned to explain how to work around its date-based
versioning scheme (by always installing packages from NonGNU ELPA
instead).  Which I think should be fine.

> - It appears that use-package is sometimes formatted using @code and
>   sometimes not.  I can't make out a consistent rule.

I've tried to follow this:

- Format use-package with no markup when referring to the package.
- Use @code{use-package} when referring to a macro call.

Does that make sense?

> - GNU ELPA is also inconsistently marked up as a single or two separate
>   acronyms.

In one sense, @acronym{GNU ELPA} is better, as that is the full name.
One way of looking at it is that the acronym for "GNU Emacs Lisp Package
Archive" is actually the acronym "GNUELPA", which we just happen to
typeset with a space for increased legibility.

But we also have @acronym{NonGNU ELPA}, and I guess we are now looking
at just a name that is not really an acronym at all?  So perhaps we
should just write out the names GNU ELPA and NonGNU ELPA without any
markup?  Because we also don't want "@acronym{NonGNU} @acronym{ELPA}", I
suppose?



  parent reply	other threads:[~2022-12-10 20:34 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-08 18:59 use-package has been merged into emacs-29 Stefan Kangas
2022-12-08 22:17 ` John Wiegley
2022-12-09 16:09 ` Philip Kaludercic
2022-12-09 16:18   ` Eli Zaretskii
2022-12-09 17:06     ` Philip Kaludercic
2022-12-09 19:00       ` Eli Zaretskii
2022-12-09 16:23   ` Eli Zaretskii
2022-12-09 16:26   ` Eli Zaretskii
2022-12-10 20:34   ` Stefan Kangas [this message]
2022-12-11  6:25     ` Eli Zaretskii
2022-12-12  1:19       ` Stefan Kangas
2022-12-12  3:36         ` Eli Zaretskii
2022-12-12  4:25           ` Stefan Kangas
2022-12-11 22:11     ` Philip Kaludercic
2022-12-12  1:19       ` Stefan Kangas
2022-12-12 20:21         ` Philip Kaludercic
  -- strict thread matches above, loose matches on Subject: below --
2022-12-09  2:11 Payas Relekar

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='CADwFkmnJ6OaDQ-USm_Ddwd6_YVqcLGJ=Tcs6BFZWV==ZANBj6A@mail.gmail.com' \
    --to=stefankangas@gmail.com \
    --cc=emacs-devel@gnu.org \
    --cc=johnw@gnu.org \
    --cc=philipk@posteo.net \
    /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.