aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorGlenn Morris2020-05-16 10:29:14 -0700
committerGlenn Morris2020-05-16 10:29:14 -0700
commit788c2480f448e97773172f3e840976dbcdc3e6c8 (patch)
tree60d3425a657e682da7790fc5f0d2548995721ef2 /doc
parenta67415a71a1be5419547ac5e2abe51bc6bb37f1d (diff)
parentb4937f64cd97ff6bf93538987c014f8ea8ff9d34 (diff)
downloademacs-788c2480f448e97773172f3e840976dbcdc3e6c8.tar.gz
emacs-788c2480f448e97773172f3e840976dbcdc3e6c8.zip
Merge from origin/emacs-27
b4937f64cd (origin/emacs-27) Improve documentation of manually instal... efd4e973a4 Reflect the emacs-devel ELPA/MELPA dispute in FAQ 28541674cd Consider face inheritance when checking region face backgr... e75f6be6cc Fix dired default file operation (bug#41261) 406fb0746c Fix documentation related to 'command-switch-alist'. 747e0a2523 Improve ediff readability in misterioso theme (Bug#41221) 48830c73e7 Fix a crash in handle_display_spec a37290a6f9 In x_hide_tip reset tip_last_frame for GTK+ tooltips only ... 3d81995692 Fix docstring of flymake-make-diagnostic (bug#40351) 632aa9d57a Go back to “Bahá’í” e2406ff60f * lisp/dired.el (dired-toggle-marks): Doc fix. (Bug#41097) # Conflicts: # doc/emacs/building.texi
Diffstat (limited to 'doc')
-rw-r--r--doc/emacs/building.texi32
-rw-r--r--doc/emacs/calendar.texi2
-rw-r--r--doc/emacs/package.texi32
-rw-r--r--doc/lispref/os.texi10
-rw-r--r--doc/misc/efaq.texi5
5 files changed, 69 insertions, 12 deletions
diff --git a/doc/emacs/building.texi b/doc/emacs/building.texi
index 77a0e807c2b..7074bd45d71 100644
--- a/doc/emacs/building.texi
+++ b/doc/emacs/building.texi
@@ -1541,6 +1541,11 @@ putting a line like this in your init file (@pxref{Init File}):
1541(add-to-list 'load-path "/path/to/my/lisp/library") 1541(add-to-list 'load-path "/path/to/my/lisp/library")
1542@end example 1542@end example
1543 1543
1544It is customary to put locally installed libraries in the
1545@file{site-lisp} directory that is already in the default value of
1546@code{load-path}, or in some subdirectory of @file{site-lisp}. This
1547way, you don't need to modify the default value of @code{load-path}.
1548
1544@cindex autoload 1549@cindex autoload
1545 Some commands are @dfn{autoloaded}; when you run them, Emacs 1550 Some commands are @dfn{autoloaded}; when you run them, Emacs
1546automatically loads the associated library first. For instance, the 1551automatically loads the associated library first. For instance, the
@@ -1563,6 +1568,33 @@ Automatic loading also occurs when completing names for
1563prefix being completed. To disable this feature, change the variable 1568prefix being completed. To disable this feature, change the variable
1564@code{help-enable-completion-autoload} to @code{nil}. 1569@code{help-enable-completion-autoload} to @code{nil}.
1565 1570
1571 Once you put your library in a directory where Emacs can find and
1572load it, you may wish to make it available at startup. This is useful
1573when the library defines features that should be available
1574automatically on demand, and manually loading the library is thus
1575inconvenient. In these cases, make sure the library will be loaded by
1576adding suitable forms to your init file: either @code{load} or
1577@code{require} (if you always need to load the library at startup), or
1578@code{autoload} if you need Emacs to load the library when some
1579command or function is invoked. For example:
1580
1581@smalllisp
1582@group
1583 ;; Loads @file{my-shining-package.elc} unconditionally.
1584 (require 'my-shining-package)
1585@end group
1586@group
1587 ;; Will load @file{my-shining-package.elc} when @code{my-func} is invoked.
1588 (autoload 'my-func "my-shining-package")
1589@end group
1590@end smalllisp
1591
1592 Note that installing a package using @code{package-install}
1593(@pxref{Package Installation}) takes care of placing the package's
1594Lisp files in a directory where Emacs will find it, and also writes
1595the necessary initialization code into your init files, making the
1596above manual customizations unnecessary.
1597
1566@node Lisp Eval 1598@node Lisp Eval
1567@section Evaluating Emacs Lisp Expressions 1599@section Evaluating Emacs Lisp Expressions
1568@cindex Emacs Lisp mode 1600@cindex Emacs Lisp mode
diff --git a/doc/emacs/calendar.texi b/doc/emacs/calendar.texi
index 8dc1a0b2df8..fe51ad35d77 100644
--- a/doc/emacs/calendar.texi
+++ b/doc/emacs/calendar.texi
@@ -532,7 +532,7 @@ holidays centered around a different month, use @kbd{C-u M-x
532holidays}, which prompts for the month and year. 532holidays}, which prompts for the month and year.
533 533
534 The holidays known to Emacs include United States holidays and the 534 The holidays known to Emacs include United States holidays and the
535major Bah@'{a}@t{'}@'{i}, Chinese, Christian, Islamic, and Jewish 535major Bahá'í, Chinese, Christian, Islamic, and Jewish
536holidays; also the solstices and equinoxes. 536holidays; also the solstices and equinoxes.
537 537
538@findex list-holidays 538@findex list-holidays
diff --git a/doc/emacs/package.texi b/doc/emacs/package.texi
index 91e44b8eba8..453d9eb4010 100644
--- a/doc/emacs/package.texi
+++ b/doc/emacs/package.texi
@@ -5,23 +5,37 @@
5@node Packages 5@node Packages
6@chapter Emacs Lisp Packages 6@chapter Emacs Lisp Packages
7@cindex Package 7@cindex Package
8@cindex Emacs Lisp package archive
9@cindex Package archive 8@cindex Package archive
10 9
11Emacs includes a facility that lets you easily download and install 10 Emacs is extended by implementing additional features in
12@dfn{packages} that implement additional features. Each package is a 11@dfn{packages}, which are Emacs Lisp libraries. These could be
13separate Emacs Lisp program, sometimes including other components such 12written by you or provided by someone else. If you want to install
14as an Info manual. 13such a package so it is available in your future Emacs session, you
14need to compile it and put it in a directory where Emacs looks for
15Lisp libraries. @xref{Lisp Libraries}, for more details about this
16manual installation method. Many packages provide installation and
17usage instructions in the large commentary near the beginning of the
18Lisp file; you can use those instructions for installing and
19fine-tuning your use of the package.
15 20
16 @kbd{M-x list-packages} brings up a buffer named @file{*Packages*} 21@cindex Emacs Lisp package archive
17with a list of all packages. You can install or uninstall packages 22 Packages can also be provided by @dfn{package archives}, which are
18via this buffer. @xref{Package Menu}. 23large collections of Emacs Lisp packages. Each package is a separate
24Emacs Lisp program, sometimes including other components such as an
25Info manual. Emacs includes a facility that lets you easily download
26and install packages from such archives. The rest of this chapter
27describes this facility.
28
29 To list the packages available for installation from package
30archives, type @w{@kbd{M-x list-packages @key{RET}}}. It brings up a
31buffer named @file{*Packages*} with a list of all packages. You can
32install or uninstall packages via this buffer. @xref{Package Menu}.
19 33
20 The command @kbd{C-h P} (@code{describe-package}) prompts for the 34 The command @kbd{C-h P} (@code{describe-package}) prompts for the
21name of a package, and displays a help buffer describing the 35name of a package, and displays a help buffer describing the
22attributes of the package and the features that it implements. 36attributes of the package and the features that it implements.
23 37
24 By default, Emacs downloads packages from a @dfn{package archive} 38 By default, Emacs downloads packages from a package archive
25maintained by the Emacs developers and hosted by the GNU project. 39maintained by the Emacs developers and hosted by the GNU project.
26Optionally, you can also download packages from archives maintained by 40Optionally, you can also download packages from archives maintained by
27third parties. @xref{Package Installation}. 41third parties. @xref{Package Installation}.
diff --git a/doc/lispref/os.texi b/doc/lispref/os.texi
index 8bf48b1dbba..8f2c7439d9f 100644
--- a/doc/lispref/os.texi
+++ b/doc/lispref/os.texi
@@ -613,7 +613,7 @@ The elements of the @code{command-switch-alist} look like this:
613@end example 613@end example
614 614
615The @sc{car}, @var{option}, is a string, the name of a command-line 615The @sc{car}, @var{option}, is a string, the name of a command-line
616option (not including the initial hyphen). The @var{handler-function} 616option (including the initial hyphen). The @var{handler-function}
617is called to handle @var{option}, and receives the option name as its 617is called to handle @var{option}, and receives the option name as its
618sole argument. 618sole argument.
619 619
@@ -623,6 +623,14 @@ remaining command-line arguments in the variable
623@code{command-line-args-left} (see below). (The entire list of 623@code{command-line-args-left} (see below). (The entire list of
624command-line arguments is in @code{command-line-args}.) 624command-line arguments is in @code{command-line-args}.)
625 625
626Note that the handling of @code{command-switch-alist} doesn't treat
627equals signs in @var{option} specially. That is, if there's an option
628like @code{--name=value} on the command line, then only a
629@code{command-switch-alist} member whose @code{car} is literally
630@code{--name=value} will match this option. If you want to parse such
631options, you need to use @code{command-line-functions} instead (see
632below).
633
626The command-line arguments are parsed by the @code{command-line-1} 634The command-line arguments are parsed by the @code{command-line-1}
627function in the @file{startup.el} file. See also @ref{Emacs 635function in the @file{startup.el} file. See also @ref{Emacs
628Invocation, , Command Line Arguments for Emacs Invocation, emacs, The 636Invocation, , Command Line Arguments for Emacs Invocation, emacs, The
diff --git a/doc/misc/efaq.texi b/doc/misc/efaq.texi
index 50a208d233b..d3a2f07e254 100644
--- a/doc/misc/efaq.texi
+++ b/doc/misc/efaq.texi
@@ -3478,7 +3478,10 @@ There are other, non-GNU, Emacs Lisp package servers, including:
3478@uref{https://marmalade-repo.org, Marmalade}. To use additional 3478@uref{https://marmalade-repo.org, Marmalade}. To use additional
3479package servers, customize the @code{package-archives} variable. Be 3479package servers, customize the @code{package-archives} variable. Be
3480aware that installing a package can run arbitrary code, so only add 3480aware that installing a package can run arbitrary code, so only add
3481sources that you trust. 3481sources that you trust. Also, packages hosted on non-GNU package
3482servers may encourage or require you to install and use non-free
3483software; for example, MELPA is known to host some packages that do
3484this.
3482 3485
3483The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources, 3486The @uref{https://lists.gnu.org/mailman/listinfo/gnu-emacs-sources,
3484GNU Emacs sources mailing list}, which is gatewayed to the 3487GNU Emacs sources mailing list}, which is gatewayed to the