diff options
| author | Philip Kaludercic | 2025-08-06 15:12:55 +0200 |
|---|---|---|
| committer | Philip Kaludercic | 2025-08-07 15:55:01 +0200 |
| commit | bdd0220f6571906b0618924274ec12fbb876a09e (patch) | |
| tree | 8c7a38e924ddb329f226a98eeec43dc331e8a67d /lisp/package/package.el | |
| parent | 5c153cfb9620baf44dd388bb509c5aca82e377e9 (diff) | |
| download | emacs-scratch/package.el-experiments.tar.gz emacs-scratch/package.el-experiments.zip | |
Split package.el into multiple filesscratch/package.el-experiments
* lisp/emacs-lisp/package.el: Replace this file with...
* lisp/emacs-lisp/package/package.el: a stub file and...
* lisp/emacs-lisp/package/package-compile.el:
file.
* lisp/emacs-lisp/package/package-describe.el:
* lisp/emacs-lisp/package/package-elpa.el:
* lisp/emacs-lisp/package/package-install.el:
* lisp/emacs-lisp/package/package-menu.el:
* lisp/emacs-lisp/package/package-misc.el:
* lisp/emacs-lisp/package/package-quickstart.el: Multiple files.
* lisp/emacs-lisp/package-vc.el: Move this file...
* lisp/emacs-lisp/package/package-vc.el: to here.
Diffstat (limited to 'lisp/package/package.el')
| -rw-r--r-- | lisp/package/package.el | 151 |
1 files changed, 151 insertions, 0 deletions
diff --git a/lisp/package/package.el b/lisp/package/package.el new file mode 100644 index 00000000000..5705a01c7da --- /dev/null +++ b/lisp/package/package.el | |||
| @@ -0,0 +1,151 @@ | |||
| 1 | ;;; package.el --- Simple package system for Emacs -*- lexical-binding:t -*- | ||
| 2 | |||
| 3 | ;; Copyright (C) 2007-2025 Free Software Foundation, Inc. | ||
| 4 | |||
| 5 | ;; Author: Tom Tromey <tromey@redhat.com> | ||
| 6 | ;; Daniel Hackney <dan@haxney.org> | ||
| 7 | ;; Created: 10 Mar 2007 | ||
| 8 | ;; Version: 1.1.0 | ||
| 9 | ;; Keywords: tools | ||
| 10 | ;; Package-Requires: ((tabulated-list "1.0")) | ||
| 11 | |||
| 12 | ;; This file is part of GNU Emacs. | ||
| 13 | |||
| 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify | ||
| 15 | ;; it under the terms of the GNU General Public License as published by | ||
| 16 | ;; the Free Software Foundation, either version 3 of the License, or | ||
| 17 | ;; (at your option) any later version. | ||
| 18 | |||
| 19 | ;; GNU Emacs is distributed in the hope that it will be useful, | ||
| 20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| 21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| 22 | ;; GNU General Public License for more details. | ||
| 23 | |||
| 24 | ;; You should have received a copy of the GNU General Public License | ||
| 25 | ;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>. | ||
| 26 | |||
| 27 | ;;; Commentary: | ||
| 28 | |||
| 29 | ;; The idea behind package.el is to be able to download packages and | ||
| 30 | ;; install them. Packages are versioned and have versioned | ||
| 31 | ;; dependencies. Furthermore, this supports built-in packages which | ||
| 32 | ;; may or may not be newer than user-specified packages. This makes | ||
| 33 | ;; it possible to upgrade Emacs and automatically disable packages | ||
| 34 | ;; which have moved from external to core. (Note though that we don't | ||
| 35 | ;; currently register any of these, so this feature does not actually | ||
| 36 | ;; work.) | ||
| 37 | |||
| 38 | ;; A package is described by its name and version. The distribution | ||
| 39 | ;; format is either a tar file or a single .el file. | ||
| 40 | |||
| 41 | ;; A tar file should be named "NAME-VERSION.tar". The tar file must | ||
| 42 | ;; unpack into a directory named after the package and version: | ||
| 43 | ;; "NAME-VERSION". It must contain a file named "PACKAGE-pkg.el" | ||
| 44 | ;; which consists of a call to define-package. It may also contain a | ||
| 45 | ;; "dir" file and the info files it references. | ||
| 46 | |||
| 47 | ;; A .el file is named "NAME-VERSION.el" in the remote archive, but is | ||
| 48 | ;; installed as simply "NAME.el" in a directory named "NAME-VERSION". | ||
| 49 | |||
| 50 | ;; The downloader downloads all dependent packages. By default, | ||
| 51 | ;; packages come from the official GNU sources, but others may be | ||
| 52 | ;; added by customizing the `package-archives' alist. Packages get | ||
| 53 | ;; byte-compiled at install time. | ||
| 54 | |||
| 55 | ;; At activation time we will set up the load-path and the info path, | ||
| 56 | ;; and we will load the package's autoloads. If a package's | ||
| 57 | ;; dependencies are not available, we will not activate that package. | ||
| 58 | |||
| 59 | ;; Conceptually a package has multiple state transitions: | ||
| 60 | ;; | ||
| 61 | ;; * Download. Fetching the package from ELPA. | ||
| 62 | ;; * Install. Untar the package, or write the .el file, into | ||
| 63 | ;; ~/.emacs.d/elpa/ directory. | ||
| 64 | ;; * Autoload generation. | ||
| 65 | ;; * Byte compile. Currently this phase is done during install, | ||
| 66 | ;; but we may change this. | ||
| 67 | ;; * Activate. Evaluate the autoloads for the package to make it | ||
| 68 | ;; available to the user. | ||
| 69 | ;; * Load. Actually load the package and run some code from it. | ||
| 70 | |||
| 71 | ;; Other external functions you may want to use: | ||
| 72 | ;; | ||
| 73 | ;; M-x list-packages | ||
| 74 | ;; Enters a mode similar to buffer-menu which lets you manage | ||
| 75 | ;; packages. You can choose packages for install (mark with "i", | ||
| 76 | ;; then "x" to execute) or deletion, and you can see what packages | ||
| 77 | ;; are available. This will automatically fetch the latest list of | ||
| 78 | ;; packages from ELPA. | ||
| 79 | ;; | ||
| 80 | ;; M-x package-install-from-buffer | ||
| 81 | ;; Install a package consisting of a single .el file that appears | ||
| 82 | ;; in the current buffer. This only works for packages which | ||
| 83 | ;; define a Version header properly; package.el also supports the | ||
| 84 | ;; extension headers Package-Version (in case Version is an RCS id | ||
| 85 | ;; or similar), and Package-Requires (if the package requires other | ||
| 86 | ;; packages). | ||
| 87 | ;; | ||
| 88 | ;; M-x package-install-file | ||
| 89 | ;; Install a package from the indicated file. The package can be | ||
| 90 | ;; either a tar file or a .el file. A tar file must contain an | ||
| 91 | ;; appropriately-named "-pkg.el" file; a .el file must be properly | ||
| 92 | ;; formatted as with `package-install-from-buffer'. | ||
| 93 | |||
| 94 | ;;; Thanks: | ||
| 95 | ;;; (sorted by sort-lines): | ||
| 96 | |||
| 97 | ;; Jim Blandy <jimb@red-bean.com> | ||
| 98 | ;; Karl Fogel <kfogel@red-bean.com> | ||
| 99 | ;; Kevin Ryde <user42@zip.com.au> | ||
| 100 | ;; Lawrence Mitchell | ||
| 101 | ;; Michael Olson <mwolson@member.fsf.org> | ||
| 102 | ;; Sebastian Tennant <sebyte@smolny.plus.com> | ||
| 103 | ;; Stefan Monnier <monnier@iro.umontreal.ca> | ||
| 104 | ;; Vinicius Jose Latorre <viniciusjl.gnu@gmail.com> | ||
| 105 | ;; Phil Hagelberg <phil@hagelb.org> | ||
| 106 | |||
| 107 | ;;; ToDo: | ||
| 108 | |||
| 109 | ;; - putting info dirs at the start of the info path means | ||
| 110 | ;; users see a weird ordering of categories. OTOH we want to | ||
| 111 | ;; override later entries. maybe emacs needs to enforce | ||
| 112 | ;; the standard layout? | ||
| 113 | ;; - put bytecode in a separate directory tree | ||
| 114 | ;; - perhaps give users a way to recompile their bytecode | ||
| 115 | ;; or do it automatically when emacs changes | ||
| 116 | ;; - give users a way to know whether a package is installed ok | ||
| 117 | ;; - give users a way to view a package's documentation when it | ||
| 118 | ;; only appears in the .el | ||
| 119 | ;; - use/extend checkdoc so people can tell if their package will work | ||
| 120 | ;; - "installed" instead of a blank in the status column | ||
| 121 | ;; - tramp needs its files to be compiled in a certain order. | ||
| 122 | ;; how to handle this? fix tramp? | ||
| 123 | ;; - maybe we need separate .elc directories for various emacs | ||
| 124 | ;; versions. That way conditional compilation can work. But would | ||
| 125 | ;; this break anything? | ||
| 126 | ;; - William Xu suggests being able to open a package file without | ||
| 127 | ;; installing it | ||
| 128 | ;; - Interface with desktop.el so that restarting after an install | ||
| 129 | ;; works properly | ||
| 130 | ;; - Use hierarchical layout. PKG/etc PKG/lisp PKG/info | ||
| 131 | ;; ... except maybe lisp? | ||
| 132 | ;; - It may be nice to have a macro that expands to the package's | ||
| 133 | ;; private data dir, aka ".../etc". Or, maybe data-directory | ||
| 134 | ;; needs to be a list (though this would be less nice) | ||
| 135 | ;; a few packages want this, eg sokoban | ||
| 136 | ;; - Allow multiple versions on the server, so that if a user doesn't | ||
| 137 | ;; meet the requirements for the most recent version they can still | ||
| 138 | ;; install an older one. | ||
| 139 | ;; - Allow optional package dependencies | ||
| 140 | ;; then if we require 'bbdb', bbdb-specific lisp in lisp/bbdb | ||
| 141 | ;; and just don't compile to add to load path ...? | ||
| 142 | ;; - Our treatment of the info path is somewhat bogus | ||
| 143 | |||
| 144 | ;;; Code: | ||
| 145 | |||
| 146 | (require 'package-install) | ||
| 147 | (require 'package-menu) | ||
| 148 | (require 'package-describe) | ||
| 149 | |||
| 150 | (provide 'package) | ||
| 151 | ;;; package.el ends here | ||