bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

[Stefan Kangas]

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

Severity: wishlist

The first patch (for elpa.git) below makes `use-package' and `bind-key'
into :core packages.  This is the first step towards retiring the old
use-package GitHub repository.[1]

The second patch makes use-package-ensure-system package into its own
separate :core package, just as it has been on MELPA.[2]  This would
facilitate users' transition, and also by installing it they will get
the necessary `system-packages' package installed as a dependency.

Stefan, does this look okay and make sense to you?  Is pushing this all
that is needed, or do we need some manual intervention in addition?

[-- Attachment #2: Type: text/plain, Size: 117 bytes --]


Footnotes:
[1]  https://github.com/jwiegley/use-package

[2]  https://melpa.org/#/use-package-ensure-system-package

[-- Attachment #3: 0001-elpa-packages-bind-key-use-package-Make-into-core-pa.patch --]
[-- Type: text/x-diff, Size: 1869 bytes --]

From b1d9a5e3bb0d0e5cddc779e8783026ad92e988c1 Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Fri, 9 Dec 2022 00:59:56 +0100
Subject: [PATCH 1/2] * elpa-packages (bind-key, use-package): Make into :core
 packages.

---
 elpa-packages | 21 ++++++++++-----------
 1 file changed, 10 insertions(+), 11 deletions(-)

diff --git a/elpa-packages b/elpa-packages
index f6c180bb2d..8b6128eaab 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -86,11 +86,7 @@
   :auto-sync nil)
  ("beacon"		:url "https://github.com/Malabarba/beacon"
   :auto-sync t)
- ("bind-key"         :url "https://github.com/jwiegley/use-package"
-  :ignored-files ("LICENSE" "doc" "Makefile*" "bind-chords.el" "use-package*"
-                  "README.md" "NEWS.md") ;; These two are for use-package.
-  :news "/dev/null"           ;l Don't use use-package' s `NEWS.md`.
-  :auto-sync t)
+ ("bind-key"            :core "lisp/use-package/bind-key.el")
  ("blist"		:url "https://gitlab.com/mmemmew/blist"
   :doc "blist.texinfo"
   :readme "README.org"
@@ -755,12 +751,15 @@
   :readme "README.md")
  ("uniquify-files"	:url nil)
  ("url-http-ntlm" 	:url nil)
- ("use-package"		:url "https://github.com/jwiegley/use-package"
-  :ignored-files ("LICENSE" "bind-*" "use-package-chords.el")
-  :readme "README.md"
-  :doc "use-package.texi"
-  :news "NEWS.md"
-  :auto-sync t)
+ ("use-package"
+  :core ("lisp/use-package/use-package-core.el"
+         "lisp/use-package/use-package-delight.el"
+         "lisp/use-package/use-package-diminish.el"
+         "lisp/use-package/use-package-ensure.el"
+         "lisp/use-package/use-package-jump.el"
+         "lisp/use-package/use-package-lint.el"
+         "lisp/use-package/use-package.el")
+  :doc "use-package.texi")
  ("url-scgi"		:url "https://github.com/skangas/url-scgi"
   :readme "README.org"
   :auto-sync t)
-- 
2.35.1


[-- Attachment #4: 0002-elpa-packages-use-package-ensure-system-package-New-.patch --]
[-- Type: text/x-diff, Size: 781 bytes --]

From 84da1ebe76571b80c558da0df2dd985093325a2d Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Fri, 9 Dec 2022 01:00:43 +0100
Subject: [PATCH 2/2] * elpa-packages (use-package-ensure-system-package): New
 package.

---
 elpa-packages | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/elpa-packages b/elpa-packages
index 8b6128eaab..a4a28bd67e 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -760,6 +760,8 @@
          "lisp/use-package/use-package-lint.el"
          "lisp/use-package/use-package.el")
   :doc "use-package.texi")
+ ("use-package-ensure-system-package"
+  :core ("lisp/use-package/use-package-ensure-system-package.el"))
  ("url-scgi"		:url "https://github.com/skangas/url-scgi"
   :readme "README.org"
   :auto-sync t)
-- 
2.35.1

bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

> Stefan, does this look okay and make sense to you?  Is pushing this all
> that is needed, or do we need some manual intervention in addition?

I think it will require manual intervention on `elpa.gnu.org` but I'll
take care of that.

> - ("bind-key"         :url "https://github.com/jwiegley/use-package"
> -  :ignored-files ("LICENSE" "doc" "Makefile*" "bind-chords.el" "use-package*"
> -                  "README.md" "NEWS.md") ;; These two are for use-package.
> -  :news "/dev/null"           ;l Don't use use-package' s `NEWS.md`.
> -  :auto-sync t)
> + ("bind-key"            :core "lisp/use-package/bind-key.el")

Looks fine.

> - ("use-package"		:url "https://github.com/jwiegley/use-package"
> -  :ignored-files ("LICENSE" "bind-*" "use-package-chords.el")
> -  :readme "README.md"
> -  :doc "use-package.texi"
> -  :news "NEWS.md"
> -  :auto-sync t)
> + ("use-package"
> +  :core ("lisp/use-package/use-package-core.el"
> +         "lisp/use-package/use-package-delight.el"
> +         "lisp/use-package/use-package-diminish.el"
> +         "lisp/use-package/use-package-ensure.el"
> +         "lisp/use-package/use-package-jump.el"
> +         "lisp/use-package/use-package-lint.el"
> +         "lisp/use-package/use-package.el")
> +  :doc "use-package.texi")

Can we use "lisp/use-package/" (and maybe the use `:ignored-files` to
strip out `bind-keys.el` or maybe even move `bind-keys.el` outside of
the `use-package` subdirectory)?

Also I suspect you need to add "doc/misc/use-package.texi" to `:core` in
order for the `:doc` to find the file.  Have you tried the above recipe?

> + ("use-package-ensure-system-package"
> +  :core ("lisp/use-package/use-package-ensure-system-package.el"))

Why do we need this as a separate package?

And while I'm here, I see in the doc:

    @lisp
    (use-package foo
      :ensure-system-package foo)
    @end lisp

    This will expect a global binary package to exist called @code{foo}.

Should we use another name than "binary package"?  In my part of the
world these things are usually called "executables" or "programs",
occasionally they're called "binaries" but I'd never heard them called
"binary packages".



        Stefan

bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

[Stefan Kangas]

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

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> I think it will require manual intervention on `elpa.gnu.org` but I'll
> take care of that.

Great!

> Can we use "lisp/use-package/" (and maybe the use `:ignored-files` to
> strip out `bind-keys.el` or maybe even move `bind-keys.el` outside of
> the `use-package` subdirectory)?

I think we could move bind-keys to lisp/emacs-lisp, if everybody agrees.

> Also I suspect you need to add "doc/misc/use-package.texi" to `:core` in
> order for the `:doc` to find the file.  Have you tried the above recipe?

You're right, it did not work without that addition.  I've changed that
in the attached, now fully tested patch.

>> + ("use-package-ensure-system-package"
>> +  :core ("lisp/use-package/use-package-ensure-system-package.el"))
>
> Why do we need this as a separate package?

Because it was like that on MELPA.  I think we might as well not do
that.

The only nice thing I see is that it would stop `use-package' from
depending on `system-packages'.  But I don't think that's a big issue,
and on the contrary doing that will make things simpler.

>     This will expect a global binary package to exist called @code{foo}.
>
> Should we use another name than "binary package"?  In my part of the
> world these things are usually called "executables" or "programs",
> occasionally they're called "binaries" but I'd never heard them called
> "binary packages".

I hope I managed to improve that with commit a9037aa8e8, thanks.

[-- Attachment #2: 0001-elpa-packages-bind-key-use-package-Make-into-core-pa.patch --]
[-- Type: text/x-diff, Size: 1782 bytes --]

From 2a2657e794e6496d5b433c40c5c2ebca92187ead Mon Sep 17 00:00:00 2001
From: Stefan Kangas <stefankangas@gmail.com>
Date: Fri, 9 Dec 2022 00:59:56 +0100
Subject: [PATCH] * elpa-packages (bind-key, use-package): Make into :core
 packages.

---
 elpa-packages | 20 +++++++++-----------
 1 file changed, 9 insertions(+), 11 deletions(-)

diff --git a/elpa-packages b/elpa-packages
index f6c180bb2d..85c5d82f6a 100644
--- a/elpa-packages
+++ b/elpa-packages
@@ -86,11 +86,7 @@
   :auto-sync nil)
  ("beacon"		:url "https://github.com/Malabarba/beacon"
   :auto-sync t)
- ("bind-key"         :url "https://github.com/jwiegley/use-package"
-  :ignored-files ("LICENSE" "doc" "Makefile*" "bind-chords.el" "use-package*"
-                  "README.md" "NEWS.md") ;; These two are for use-package.
-  :news "/dev/null"           ;l Don't use use-package' s `NEWS.md`.
-  :auto-sync t)
+ ("bind-key"            :core "lisp/use-package/bind-key.el")
  ("blist"		:url "https://gitlab.com/mmemmew/blist"
   :doc "blist.texinfo"
   :readme "README.org"
@@ -755,12 +751,14 @@
   :readme "README.md")
  ("uniquify-files"	:url nil)
  ("url-http-ntlm" 	:url nil)
- ("use-package"		:url "https://github.com/jwiegley/use-package"
-  :ignored-files ("LICENSE" "bind-*" "use-package-chords.el")
-  :readme "README.md"
-  :doc "use-package.texi"
-  :news "NEWS.md"
-  :auto-sync t)
+ ("use-package"
+  :core ("lisp/use-package/"
+         "doc/emacs/doclicense.texi"
+         "doc/emacs/docstyle.texi"
+         "doc/misc/use-package.texi")
+  :shell-command "(echo '@set USEP_DIST from GNU ELPA'; echo '@set EMACSVER') >emacsver.texi"
+  :excludes ("bind-key.el")
+  :doc "use-package.texi")
  ("url-scgi"		:url "https://github.com/skangas/url-scgi"
   :readme "README.org"
   :auto-sync t)
-- 
2.35.1

bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

[Stefan Monnier via Bug reports for GNU Emacs, the Swiss army knife of text editors]

>> Can we use "lisp/use-package/" (and maybe the use `:ignored-files` to
>> strip out `bind-keys.el` or maybe even move `bind-keys.el` outside of
>> the `use-package` subdirectory)?
> I think we could move bind-keys to lisp/emacs-lisp, if everybody agrees.

[ I don't have an opinion on this.  ]

>>> + ("use-package-ensure-system-package"
>>> +  :core ("lisp/use-package/use-package-ensure-system-package.el"))
>> Why do we need this as a separate package?
> Because it was like that on MELPA.

Doesn't sound like a strong enough reason.

> I think we might as well not do that.

I'm glad you agree.

> The only nice thing I see is that it would stop `use-package' from
> depending on `system-packages'.  But I don't think that's a big issue,
> and on the contrary doing that will make things simpler.

We can include `use-package-ensure-system-package.el` without adding
a dependency on `system-packages`.  Just like `use-package` did not
depend on `use-package-ensure-system-package` in MELPA.
[ Or just like Emacs itself now includes `use-package` and
  `use-package-ensure-system-package.el` but not `system-packages`.  ]

The patch looks good to me, feel free to push,


        Stefan

bug#59914: [GNU ELPA] Make use-package and bind-key into :core packages

[Stefan Kangas]

Stefan Monnier <monnier@iro.umontreal.ca> writes:

> The patch looks good to me, feel free to push,

Thanks, done.