diff options
author | Eli Zaretskii <eliz@gnu.org> | 2023-04-15 13:02:04 -0400 |
---|---|---|
committer | Eli Zaretskii <eliz@gnu.org> | 2023-04-15 13:02:04 -0400 |
commit | 7191318b716debaca15b56ebf7b13f5a1b07b0f9 (patch) | |
tree | 010209f880a0076436ef0140ef11883dddd88ad9 /doc | |
parent | febf4467bde3a7d90265f826f7e450a5c0f6ca46 (diff) | |
parent | 864a4dc236395e441aafd23b9cbca099afdc5324 (diff) | |
download | emacs-7191318b716debaca15b56ebf7b13f5a1b07b0f9.tar.gz |
Merge from origin/emacs-29
864a4dc2363 Fix compilation of w32.c with old MinGW system headers
a22eb9ae0f9 ruby-add-log-current-method: Reduce the use of 'nreverse'
17d803d0a75 Fix detection of WebP images by their signature
43290391ce2 ; Eglot: make version parseable by version-to-list
6e6e8b5c974 Add more documentation for the keys of `package-vc-select...
7972b76c2c7 ; vc-checkout: Wrap var lookup in 'bound-and-true-p'
e9fef1d70ff vc-checkout: Try to use the vc-dir's backend first
372e024accd ; Fix wallpaper-tests on XFCE
7055fd8e43e Improve documentation related to 'ispell-complete-word'
61fd017abde * configure.ac: Add -lbsd on Haiku.
05971c4d9a4 Add menu to 'c-ts-mode' and 'c++-ts-mode'
# Conflicts:
# lisp/progmodes/eglot.el
# lisp/progmodes/ruby-mode.el
Diffstat (limited to 'doc')
-rw-r--r-- | doc/emacs/package.texi | 77 |
1 files changed, 77 insertions, 0 deletions
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi index 7a2bc11d03c..2b03399b0a7 100644 --- a/doc/emacs/package.texi +++ b/doc/emacs/package.texi @@ -578,3 +578,80 @@ from the package directory (@pxref{Package Files}) to your checkout and initializes the code. Note that you might have to use @code{package-vc-refresh} to repeat the initialization and update the autoloads. + +@subsection Specifying Package Sources +@cindex package specification +@cindex specification, for source packages + + To install a package from source, Emacs must know where to get the +package's source code (such as a code repository) and basic +information about the structure of the code (such as the main file in +a multi-file package). A @dfn{package specification} describes these +properties. + + When supported by a package archive (@pxref{Package +Archives,,,elisp, The Emacs Lisp Reference Manual}), Emacs can +automatically download a package's specification from said archive. +If the first argument passed to @code{package-vc-install} is a symbol +naming a package, then Emacs will use the specification provided by +the archive for that package. + +@example +@group +;; Emacs will download BBDB's specification from GNU ELPA: +(package-vc-install 'bbdb) +@end group +@end example + + The first argument to @code{package-vc-install} may also be a +package specification. This allows you to install source packages +from locations other than the known archives listed in the user option +@code{package-archives}. A package specification is a list of the +form @code{(@var{name} . @var{spec})}, in which @var{spec} should be a +property list using any of the keys in the table below. + +For definitions of basic terms for working with code repositories and +version control systems, see @ref{VCS Concepts,,,emacs, The GNU Emacs +Manual}. + +@table @code +@item :url +A string providing the URL that specifies the repository from which to +fetch the package's source code. + +@item :branch +A string providing the revision of the code to install. Do not +confuse this with a package's version number. + +@item :lisp-dir +A string providing the repository-relative name of the directory to +use for loading the Lisp sources, which defaults to the root directory +of the repository. + +@item :main-file +A string providing the main file of the project, from which to gather +package metadata. If not given, the default is the package name with +".el" appended to it. + +@item :doc +A string providing the repository-relative name of the documentation +file from which to build an Info file. This can be a Texinfo file or +an Org file. + +@item :vc-backend +A symbol naming the VC backend to use for downloading a copy of the +package's repository (@pxref{Version Control Systems,,,emacs, The GNU +Emacs Manual}). If omitted, Emacs will attempt to make a guess based +on the provided URL, or, failing that, the process will fall back onto +the value of @code{package-vc-default-backend}. +@end table + +@example +@group +;; Specifying information manually: +(package-vc-install + '(bbdb :url "https://git.savannah.nongnu.org/git/bbdb.git" + :lisp-dir "lisp" + :doc "doc/bbdb.texi")) +@end group +@end example |