diff options
| author | Stefan Kangas <stefankangas@gmail.com> | 2019-07-14 05:59:46 +0200 |
|---|---|---|
| committer | Noam Postavsky <npostavs@gmail.com> | 2019-07-25 18:23:55 -0400 |
| commit | 16a529e215331626f66160194701b74248cb9fa5 (patch) | |
| tree | d6b93dd1b66121bcd8f64405c9f75c8a569ed7e9 /lisp/emacs-lisp | |
| parent | 78e6c2ada6e04c3fe3e1d4777cb316a514d510dd (diff) | |
| download | emacs-16a529e215331626f66160194701b74248cb9fa5.tar.gz emacs-16a529e215331626f66160194701b74248cb9fa5.tar.bz2 emacs-16a529e215331626f66160194701b74248cb9fa5.zip | |
Remove upload functionality of package-x from the elisp manual
Suggested by Stefan Monnier.
Ref: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=19537#8
* doc/lispref/package.texi (Package Archives): Don't document
package-x upload functions in the elisp manual, since they are not
very commonly used. (Bug#19537)
* lisp/emacs-lisp/package-x.el (package-archive-upload-base)
(package-upload-buffer, package-upload-file): Add to the doc strings
any details removed from the elisp manual that would otherwise be
missing.
Diffstat (limited to 'lisp/emacs-lisp')
| -rw-r--r-- | lisp/emacs-lisp/package-x.el | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/lisp/emacs-lisp/package-x.el b/lisp/emacs-lisp/package-x.el index a207ece885f..9e63dce6d7b 100644 --- a/lisp/emacs-lisp/package-x.el +++ b/lisp/emacs-lisp/package-x.el @@ -47,6 +47,8 @@ (defcustom package-archive-upload-base "/path/to/archive" "The base location of the archive to which packages are uploaded. +The commands in the package-x library will use this as base +location. This should be an absolute directory name. If the archive is on another machine, you may specify a remote name in the usual way, e.g. \"/ssh:foo@example.com:/var/www/packages/\". @@ -273,7 +275,9 @@ if it exists." (defun package-upload-buffer () "Upload the current buffer as a single-file Emacs Lisp package. If `package-archive-upload-base' does not specify a valid upload -destination, prompt for one." +destination, prompt for one. +Signal an error if the current buffer is not visiting a simple +package (a \".el\" file)." (interactive) (save-excursion (save-restriction @@ -286,8 +290,13 @@ destination, prompt for one." Interactively, prompt for FILE. The package is considered a single-file package if FILE ends in \".el\", and a multi-file package if FILE ends in \".tar\". +Automatically extract package attributes and update the archive's +contents list with this information. If `package-archive-upload-base' does not specify a valid upload -destination, prompt for one." +destination, prompt for one. If the directory does not exist, it +is created. The directory need not have any initial contents +\(i.e., you can use this command to populate an initially empty +archive)." (interactive "fPackage file name: ") (with-temp-buffer (insert-file-contents file) |