diff options
| author | John Wiegley | 2022-08-08 12:25:35 -0700 |
|---|---|---|
| committer | GitHub | 2022-08-08 12:25:35 -0700 |
| commit | e8626100f335a6b3bb5bb5cdee353b2b30435be7 (patch) | |
| tree | 0cd0a5c7bb8e4530ce16c154ba9d0a4b921fb1d1 | |
| parent | 0dc78ef4c875e33b677e2ac13a2105bcbf45288e (diff) | |
| parent | 835fdb16be2fa95508549173b1d935d3f754c6e8 (diff) | |
| download | emacs-e8626100f335a6b3bb5bb5cdee353b2b30435be7.tar.gz emacs-e8626100f335a6b3bb5bb5cdee353b2b30435be7.zip | |
Merge pull request from tarsiiformes/cleanup-manual
GitHub-reference: https://github.com/jwiegley/use-package/issues/968
| -rw-r--r-- | doc/misc/use-package.texi | 128 |
1 files changed, 19 insertions, 109 deletions
diff --git a/doc/misc/use-package.texi b/doc/misc/use-package.texi index 880af1203b6..2b868564372 100644 --- a/doc/misc/use-package.texi +++ b/doc/misc/use-package.texi | |||
| @@ -8,7 +8,7 @@ | |||
| 8 | 8 | ||
| 9 | @copying | 9 | @copying |
| 10 | @quotation | 10 | @quotation |
| 11 | Copyright (C) 2012-2017 John Wiegley <johnw@@newartisans.com> | 11 | Copyright (C) 2012-2022 John Wiegley <johnw@@newartisans.com> |
| 12 | 12 | ||
| 13 | You can redistribute this document and/or modify it under the terms | 13 | You can redistribute this document and/or modify it under the terms |
| 14 | of the GNU General Public License as published by the Free Software | 14 | of the GNU General Public License as published by the Free Software |
| @@ -31,7 +31,7 @@ General Public License for more details. | |||
| 31 | @finalout | 31 | @finalout |
| 32 | @titlepage | 32 | @titlepage |
| 33 | @title use-package User Manual | 33 | @title use-package User Manual |
| 34 | @subtitle for version 2.4.1 | 34 | @subtitle for version 2.4.1-81-gb185c6b+1 |
| 35 | @author John Wiegley | 35 | @author John Wiegley |
| 36 | @page | 36 | @page |
| 37 | @vskip 0pt plus 1filll | 37 | @vskip 0pt plus 1filll |
| @@ -44,20 +44,13 @@ General Public License for more details. | |||
| 44 | @node Top | 44 | @node Top |
| 45 | @top use-package User Manual | 45 | @top use-package User Manual |
| 46 | 46 | ||
| 47 | use-package is@dots{} | 47 | The @code{use-package} macro allows you to isolate package configuration in your |
| 48 | 48 | @code{.emacs} file in a way that is both performance-oriented and, well, tidy. I | |
| 49 | @quotation | 49 | created it because I have over 80 packages that I use in Emacs, and things |
| 50 | Copyright (C) 2012-2017 John Wiegley <johnw@@newartisans.com> | 50 | were getting difficult to manage. Yet with this utility my total load time is |
| 51 | 51 | around 2 seconds, with no loss of functionality! | |
| 52 | You can redistribute this document and/or modify it under the terms of the GNU | ||
| 53 | General Public License as published by the Free Software Foundation, either | ||
| 54 | version 3 of the License, or (at your option) any later version. | ||
| 55 | |||
| 56 | This document is distributed in the hope that it will be useful, but WITHOUT | ||
| 57 | ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS | ||
| 58 | FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. | ||
| 59 | 52 | ||
| 60 | @end quotation | 53 | @insertcopying |
| 61 | @end ifnottex | 54 | @end ifnottex |
| 62 | 55 | ||
| 63 | @menu | 56 | @menu |
| @@ -67,11 +60,7 @@ FOR A PARTICULAR PURPOSE@. See the GNU General Public License for more details. | |||
| 67 | * Basic Concepts:: | 60 | * Basic Concepts:: |
| 68 | * Issues/Requests:: | 61 | * Issues/Requests:: |
| 69 | * Keywords:: | 62 | * Keywords:: |
| 70 | * FAQ:: | ||
| 71 | * Debugging Tools:: | 63 | * Debugging Tools:: |
| 72 | * Command Index:: | ||
| 73 | * Function Index:: | ||
| 74 | * Variable Index:: | ||
| 75 | 64 | ||
| 76 | @detailmenu | 65 | @detailmenu |
| 77 | --- The Detailed Node Listing --- | 66 | --- The Detailed Node Listing --- |
| @@ -109,21 +98,6 @@ Keywords | |||
| 109 | * Binding to local keymaps:: | 98 | * Binding to local keymaps:: |
| 110 | 99 | ||
| 111 | 100 | ||
| 112 | FAQ | ||
| 113 | |||
| 114 | * FAQ - How to @dots{}?:: | ||
| 115 | * FAQ - Issues and Errors:: | ||
| 116 | |||
| 117 | FAQ - How to @dots{}? | ||
| 118 | |||
| 119 | * This is a question:: | ||
| 120 | |||
| 121 | |||
| 122 | FAQ - Issues and Errors | ||
| 123 | |||
| 124 | * This is an issues:: | ||
| 125 | |||
| 126 | |||
| 127 | @end detailmenu | 101 | @end detailmenu |
| 128 | @end menu | 102 | @end menu |
| 129 | 103 | ||
| @@ -141,12 +115,6 @@ More text to come@dots{} | |||
| 141 | @node Installation | 115 | @node Installation |
| 142 | @chapter Installation | 116 | @chapter Installation |
| 143 | 117 | ||
| 144 | @menu | ||
| 145 | * Installing from an Elpa Archive:: | ||
| 146 | * Installing from the Git Repository:: | ||
| 147 | * Post-Installation Tasks:: | ||
| 148 | @end menu | ||
| 149 | |||
| 150 | use-package can be installed using Emacs' package manager or manually from | 118 | use-package can be installed using Emacs' package manager or manually from |
| 151 | its development repository. | 119 | its development repository. |
| 152 | 120 | ||
| @@ -276,8 +244,7 @@ use-package-version’s value is "2.4.1" | |||
| 276 | 244 | ||
| 277 | If you are completely new to use-package then see @ref{Getting Started}. | 245 | If you are completely new to use-package then see @ref{Getting Started}. |
| 278 | 246 | ||
| 279 | If you run into problems, then please see the | 247 | If you run into problems, then please see the @ref{Debugging Tools}. |
| 280 | @ref{FAQ}. Also see the @ref{Debugging Tools}. | ||
| 281 | 248 | ||
| 282 | @node Getting Started | 249 | @node Getting Started |
| 283 | @chapter Getting Started | 250 | @chapter Getting Started |
| @@ -293,25 +260,22 @@ those decisions clearer: | |||
| 293 | 260 | ||
| 294 | @itemize | 261 | @itemize |
| 295 | @item | 262 | @item |
| 296 | To gather all configuration details of a package into one place, making | 263 | To gather all configuration details of a package into one place, |
| 297 | it easier to copy, disable, or move it elsewhere in the init file. | 264 | making it easier to copy, disable, or move it elsewhere in the init |
| 298 | 265 | file. | |
| 299 | 266 | ||
| 300 | @item | 267 | @item |
| 301 | To reduce duplication and boilerplate, capturing several common practices | 268 | To reduce duplication and boilerplate, capturing several common |
| 302 | as mere keywords both easy and intuitive to use. | 269 | practices as mere keywords both easy and intuitive to use. |
| 303 | |||
| 304 | 270 | ||
| 305 | @item | 271 | @item |
| 306 | To make startup time of Emacs as quick as possible, without sacrificing | 272 | To make startup time of Emacs as quick as possible, without |
| 307 | the quantity of add-on packages used. | 273 | sacrificing the quantity of add-on packages used. |
| 308 | |||
| 309 | 274 | ||
| 310 | @item | 275 | @item |
| 311 | To make it so errors encountered during startup disable only the package | 276 | To make it so errors encountered during startup disable only the |
| 312 | raising the error, and as little else as possible, leaving a close to a | 277 | package raising the error, and as little else as possible, leaving a |
| 313 | functional Emacs as possible. | 278 | close to a functional Emacs as possible. |
| 314 | |||
| 315 | 279 | ||
| 316 | @item | 280 | @item |
| 317 | To allow byte-compilation of one's init file so that any warnings or | 281 | To allow byte-compilation of one's init file so that any warnings or |
| @@ -997,63 +961,9 @@ As a convenience, a list of such packages may be specified: | |||
| 997 | For more complex logic, such as that supported by @code{:after}, simply use @code{:if} | 961 | For more complex logic, such as that supported by @code{:after}, simply use @code{:if} |
| 998 | and the appropriate Lisp expression. | 962 | and the appropriate Lisp expression. |
| 999 | 963 | ||
| 1000 | @node FAQ | ||
| 1001 | @appendix FAQ | ||
| 1002 | |||
| 1003 | The next two nodes lists frequently asked questions. | ||
| 1004 | |||
| 1005 | Please also use the @ref{Debugging Tools}. | ||
| 1006 | |||
| 1007 | @menu | ||
| 1008 | * FAQ - How to @dots{}?:: | ||
| 1009 | * FAQ - Issues and Errors:: | ||
| 1010 | @end menu | ||
| 1011 | |||
| 1012 | @node FAQ - How to @dots{}? | ||
| 1013 | @appendixsec FAQ - How to @dots{}? | ||
| 1014 | |||
| 1015 | @menu | ||
| 1016 | * This is a question:: | ||
| 1017 | @end menu | ||
| 1018 | |||
| 1019 | @node This is a question | ||
| 1020 | @appendixsubsec This is a question | ||
| 1021 | |||
| 1022 | This is an answer. | ||
| 1023 | |||
| 1024 | @node FAQ - Issues and Errors | ||
| 1025 | @appendixsec FAQ - Issues and Errors | ||
| 1026 | |||
| 1027 | @menu | ||
| 1028 | * This is an issues:: | ||
| 1029 | @end menu | ||
| 1030 | |||
| 1031 | @node This is an issues | ||
| 1032 | @appendixsubsec This is an issues | ||
| 1033 | |||
| 1034 | This is a description. | ||
| 1035 | |||
| 1036 | @node Debugging Tools | 964 | @node Debugging Tools |
| 1037 | @chapter Debugging Tools | 965 | @chapter Debugging Tools |
| 1038 | 966 | ||
| 1039 | TODO | 967 | TODO |
| 1040 | 968 | ||
| 1041 | Please also see the @ref{FAQ}. | ||
| 1042 | |||
| 1043 | @node Command Index | ||
| 1044 | @appendix Command Index | ||
| 1045 | |||
| 1046 | @printindex cp | ||
| 1047 | |||
| 1048 | @node Function Index | ||
| 1049 | @appendix Function Index | ||
| 1050 | |||
| 1051 | @printindex fn | ||
| 1052 | |||
| 1053 | @node Variable Index | ||
| 1054 | @appendix Variable Index | ||
| 1055 | |||
| 1056 | @printindex vr | ||
| 1057 | |||
| 1058 | Emacs 28.0.92 (Org mode 9.5.2) | ||
| 1059 | @bye | 969 | @bye |