diff options
| author | Stefan Kangas | 2022-12-10 12:59:30 +0100 |
|---|---|---|
| committer | Stefan Kangas | 2022-12-10 13:00:46 +0100 |
| commit | 2f1269c3331bfe2b570a9238ce52dafb14c3cf7b (patch) | |
| tree | 6c81b70c116bb7193305b7a5adf7756c56a16a10 /doc/misc | |
| parent | 1b7ece2095614fc5ff08cfc03641720ba1143100 (diff) | |
| download | emacs-2f1269c3331bfe2b570a9238ce52dafb14c3cf7b.tar.gz emacs-2f1269c3331bfe2b570a9238ce52dafb14c3cf7b.zip | |
; Fix some minor issues in use-package.texi
* doc/misc/use-package.texi: Fix some minor issues.
Diffstat (limited to 'doc/misc')
| -rw-r--r-- | doc/misc/use-package.texi | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/doc/misc/use-package.texi b/doc/misc/use-package.texi index d3b6ee99003..7975138bd6f 100644 --- a/doc/misc/use-package.texi +++ b/doc/misc/use-package.texi | |||
| @@ -652,12 +652,11 @@ elisp, GNU Emacs Lisp Reference Manual}). Further, this value is fixed at | |||
| 652 | whatever was determined during compilation, to avoid looking up the | 652 | whatever was determined during compilation, to avoid looking up the |
| 653 | same information again on each startup. For example: | 653 | same information again on each startup. For example: |
| 654 | 654 | ||
| 655 | @c FIXME: the below should use shell-command-to-string, surely? | ||
| 656 | @lisp | 655 | @lisp |
| 657 | @group | 656 | @group |
| 658 | (eval-and-compile | 657 | (eval-and-compile |
| 659 | (defun ess-site-load-path () | 658 | (defun ess-site-load-path () |
| 660 | (shell-command "find ~ -path ess/lisp"))) | 659 | (shell-command-to-string "find ~ -path ess/lisp"))) |
| 661 | @end group | 660 | @end group |
| 662 | 661 | ||
| 663 | @group | 662 | @group |
| @@ -739,10 +738,8 @@ function and variable definitions that will: | |||
| 739 | 738 | ||
| 740 | @enumerate | 739 | @enumerate |
| 741 | @item | 740 | @item |
| 742 | @c FIXME: ``within a guard block''? what's that?? | ||
| 743 | Make the byte-compiler happy: it will not complain about functions | 741 | Make the byte-compiler happy: it will not complain about functions |
| 744 | whose definitions are unknown because you have them within a guard | 742 | whose definitions are unknown. |
| 745 | block. | ||
| 746 | 743 | ||
| 747 | @item | 744 | @item |
| 748 | Define functions and variables that will be used in an @code{:if} | 745 | Define functions and variables that will be used in an @code{:if} |
| @@ -1684,9 +1681,9 @@ them directly to the developers of that package manager. | |||
| 1684 | 1681 | ||
| 1685 | Some users might want to byte-compile their init file to make Emacs | 1682 | Some users might want to byte-compile their init file to make Emacs |
| 1686 | startup faster. This is not recommended in most cases, as the | 1683 | startup faster. This is not recommended in most cases, as the |
| 1687 | speed-up is often too small to be worth it, and can lead to confusion | 1684 | speed-up is usually too small to be worth it, and it can lead to |
| 1688 | if the byte-compiled files are out-of-date. If you still want to do | 1685 | confusion if the byte-compiled files are out-of-date. If you still |
| 1689 | it, this chapter explains how to do that. | 1686 | want to do it, this chapter explains how to do that. |
| 1690 | 1687 | ||
| 1691 | @code{use-package} always loads every library that it can while a file | 1688 | @code{use-package} always loads every library that it can while a file |
| 1692 | is being byte-compiled. This helps silence spurious warnings about | 1689 | is being byte-compiled. This helps silence spurious warnings about |
| @@ -1962,7 +1959,7 @@ together with @code{:ensure}. | |||
| 1962 | @end group | 1959 | @end group |
| 1963 | @end lisp | 1960 | @end lisp |
| 1964 | 1961 | ||
| 1965 | For example, on a @code{Debian GNU/Linux} system, this would call | 1962 | For example, on a Debian GNU/Linux system, this would call |
| 1966 | @samp{apt-get install foo}. | 1963 | @samp{apt-get install foo}. |
| 1967 | 1964 | ||
| 1968 | If the package is named differently than the binary, you can use a | 1965 | If the package is named differently than the binary, you can use a |
| @@ -1976,11 +1973,10 @@ cons in the form of @code{(binary . package-name)}. For example: | |||
| 1976 | @end group | 1973 | @end group |
| 1977 | @end lisp | 1974 | @end lisp |
| 1978 | 1975 | ||
| 1979 | On a @code{Debian GNU/Linux} system, this would call @code{apt install | 1976 | On a Debian GNU/Linux system, this would call @code{apt install foo} |
| 1980 | foo} if Emacs could not locate the executable | 1977 | if Emacs could not locate the executable @code{foocmd}.@footnote{For |
| 1981 | @code{foocmd}.@footnote{For manual testing, you could use the | 1978 | manual testing, you could use the @code{executable-find} function, |
| 1982 | @code{executable-find} function, which is what @samp{system-packages} | 1979 | which is what @samp{system-packages} uses internally.} |
| 1983 | uses internally.} | ||
| 1984 | 1980 | ||
| 1985 | @code{:ensure-system-package} can also take a cons where the | 1981 | @code{:ensure-system-package} can also take a cons where the |
| 1986 | @code{cdr} is a string that will get called by | 1982 | @code{cdr} is a string that will get called by |