Commit graph

49 commits

Author SHA1 Message Date
Eli Zaretskii
b1be0f2ba6 Document issues with 'use-package's ':custom' and byte compilation
* doc/misc/use-package.texi (User options): Warn against
byte-compiling init files that use ':custom'.  (Bug#73609)
2024-11-09 11:55:49 +02:00
Stefan Kangas
a799661566 Standardize possessive apostrophe usage in manuals, docs, and comments
See the note in admin/notes/documentation.
Ref: https://lists.gnu.org/r/emacs-devel/2012-02/msg00649.html
2024-07-25 03:35:18 +02:00
Eli Zaretskii
cb633820c1 ; * doc/misc/use-package.texi (Getting Started): Fix wording. 2024-07-24 14:01:01 +03:00
Stefan Kangas
05629d3af0 Delete redundant "a.k.a." in use-package.texi
* doc/misc/use-package.texi (Getting Started): Delete redundant
acronym "a.k.a.".  (Bug#66350)
2024-07-23 23:32:56 +02:00
Stefan Kangas
c7609464f7 Document (use-package 'emacs) declarations
* doc/misc/use-package.texi (The @code{emacs} package): New
node.  (Bug#66350)
2024-07-23 15:16:27 +02:00
Stefan Kangas
c1382257aa ; Fix typo in use-package.texi
* doc/misc/use-package.texi (Getting Started): Fix typo.
Problem reported by GitHub user Paul Jensen (psnj) in:
https://github.com/jwiegley/use-package/pull/1070/
2024-07-22 18:07:29 +02:00
Stefan Kangas
00adee897a ; Fix punctuation in docs 2024-07-21 17:35:13 +02:00
Tony Zorman
77115be256 Add use-package-vc-prefer-newest user option
* lisp/use-package/use-package-core.el (use-package-vc-prefer-newest):
User option to prefer the latest commit (as opposed to the latest
release) of a package.
(use-package-normalize--vc-arg): Check for
use-package-vc-prefer-newest.

* doc/misc/use-package.texi (Install package): Document
use-package-vc-prefer-newest.

* etc/NEWS: Document use-package-vc-prefer-newest.
2024-03-30 13:49:21 +01:00
Po Lu
ecf08f0621 Merge from savannah/emacs-29
dc4e6b1329 ; Update copyright years in more files
64b3777631 ; Run set-copyright from admin.el
8e1c56ae46 ; Add 2024 to copyright years

# Conflicts:
#	doc/misc/modus-themes.org
#	doc/misc/texinfo.tex
#	etc/NEWS
#	etc/refcards/ru-refcard.tex
#	etc/themes/modus-operandi-theme.el
#	etc/themes/modus-themes.el
#	etc/themes/modus-vivendi-theme.el
#	lib/alloca.in.h
#	lib/binary-io.h
#	lib/c-ctype.h
#	lib/c-strcasecmp.c
#	lib/c-strncasecmp.c
#	lib/careadlinkat.c
#	lib/cloexec.c
#	lib/close-stream.c
#	lib/diffseq.h
#	lib/dup2.c
#	lib/filemode.h
#	lib/fpending.c
#	lib/fpending.h
#	lib/fsusage.c
#	lib/getgroups.c
#	lib/getloadavg.c
#	lib/gettext.h
#	lib/gettime.c
#	lib/gettimeofday.c
#	lib/group-member.c
#	lib/malloc.c
#	lib/md5-stream.c
#	lib/md5.c
#	lib/md5.h
#	lib/memmem.c
#	lib/memrchr.c
#	lib/nanosleep.c
#	lib/save-cwd.h
#	lib/sha1.c
#	lib/sig2str.c
#	lib/stdlib.in.h
#	lib/strtoimax.c
#	lib/strtol.c
#	lib/strtoll.c
#	lib/time_r.c
#	lib/xalloc-oversized.h
#	lisp/auth-source-pass.el
#	lisp/emacs-lisp/lisp-mnt.el
#	lisp/emacs-lisp/timer.el
#	lisp/info-look.el
#	lisp/jit-lock.el
#	lisp/loadhist.el
#	lisp/mail/rmail.el
#	lisp/net/ntlm.el
#	lisp/net/webjump.el
#	lisp/progmodes/asm-mode.el
#	lisp/progmodes/project.el
#	lisp/progmodes/sh-script.el
#	lisp/textmodes/flyspell.el
#	lisp/textmodes/reftex-toc.el
#	lisp/textmodes/reftex.el
#	lisp/textmodes/tex-mode.el
#	lisp/url/url-gw.el
#	m4/alloca.m4
#	m4/clock_time.m4
#	m4/d-type.m4
#	m4/dirent_h.m4
#	m4/dup2.m4
#	m4/euidaccess.m4
#	m4/fchmodat.m4
#	m4/filemode.m4
#	m4/fsusage.m4
#	m4/getgroups.m4
#	m4/getloadavg.m4
#	m4/getrandom.m4
#	m4/gettime.m4
#	m4/gettimeofday.m4
#	m4/gnulib-common.m4
#	m4/group-member.m4
#	m4/inttypes.m4
#	m4/malloc.m4
#	m4/manywarnings.m4
#	m4/mempcpy.m4
#	m4/memrchr.m4
#	m4/mkostemp.m4
#	m4/mktime.m4
#	m4/nproc.m4
#	m4/nstrftime.m4
#	m4/pathmax.m4
#	m4/pipe2.m4
#	m4/pselect.m4
#	m4/pthread_sigmask.m4
#	m4/readlink.m4
#	m4/realloc.m4
#	m4/sig2str.m4
#	m4/ssize_t.m4
#	m4/stat-time.m4
#	m4/stddef_h.m4
#	m4/stdint.m4
#	m4/stdio_h.m4
#	m4/stdlib_h.m4
#	m4/stpcpy.m4
#	m4/strnlen.m4
#	m4/strtoimax.m4
#	m4/strtoll.m4
#	m4/time_h.m4
#	m4/timegm.m4
#	m4/timer_time.m4
#	m4/timespec.m4
#	m4/unistd_h.m4
#	m4/warnings.m4
#	nt/configure.bat
#	nt/preprep.c
#	test/lisp/register-tests.el
2024-01-02 10:28:14 +08:00
Po Lu
8e1c56ae46 ; Add 2024 to copyright years 2024-01-02 09:47:10 +08:00
Po Lu
6ad14b658f Correct typos in the manuals
* doc/misc/tramp.texi (Traces and Profiles): Don't mimic
@enumerate with @indentedblock, which is absent from Texinfo
4.13.

* doc/misc/use-package.texi (Global keybindings): Remove stray
comma after @xref.
2023-10-26 19:46:32 +08:00
Po Lu
ae33788410 Revise documentation concerning selections outside X
* doc/lispref/frames.texi (Accessing Selections, X Selections):
Correct markup, averting the recognition of X followed by a
sentence stop as an acronym.
(Other Selections): Relate the nature of the MS-Windows
selection emulation, how it functions, and its deficiencies.
Clarify paragraphs concerning PGTK and Nextstep.

* doc/misc/efaq.texi (Emacs in a Linux console):

* doc/misc/use-package.texi (Conditional loading): Correct
markup, averting the recognition of X followed by a sentence
stop as an acronym.
2023-10-22 07:55:12 +00:00
Eli Zaretskii
d1ddd1d5d9 Merge from origin/emacs-29
84d2da003e ; Fix example in the Flymake manual
0a1459f1d9 * doc/misc/calc.texi (Advanced Math Functions): Correct c...
92faf1f564 Consider 'dired-kill-when-opening-new-dired-buffer' in mo...
bafe71a69f ; Fix use-package.texi markup
018e4ca6c5 ; * doc/misc/calc.texi (Advanced Math Functions): Fix las...
1952dbd4c5 Fix Gamma function definition in calc.texi
f73f82d7e8 Fix subscripts in the Calc manual
70fc7c41ef Improve documentation of 'declare' forms
c835758238 ; * src/lread.c (bytecode_from_rev_list): Avoid C++ comment.
2847857496 Improve tree-sitter docs
0e9307eb2b Fix some Texinfo markup in manuals
8dc08333ee Fix bol/bos anchors in tree-sitter :match regexps
8225ade615 ; * src/xdisp.c (syms_of_xdisp) <display-line-numbers>: F...
1f0527a312 ; Fix last change in tex-mode.el
4da479920e * lisp/subr.el (with-restriction): Tweak indent rule
36aa9bd818 ; Fix previous change
aaeaf608d8 Fix setting region in the minibuffer
1383efe01d Fix setting $DBUS_SESSION_BUS_ADDRESS after Emacs has sta...
bdb0bc2b4e Fix tex-mode display-buffer issues
90047c38ce Add test for when 'completion-auto-help' is 'visible'
2c623e4feb Avoid errors in 'apropos-documentation' after 'eval-buffer'
dd3b98121c ; * doc/emacs/indent.texi (Indentation Commands): Fix las...
904edf1f07 Mention indent-rigidly in the Emacs manual
2023-06-17 05:02:55 -04:00
Robert Pluim
bafe71a69f ; Fix use-package.texi markup
* doc/misc/use-package.texi (Best practices): It's a subsection, not a
subheading.
2023-06-15 12:23:29 +02:00
Tony Zorman
2ce279680b Add :vc keyword to use-package for VC package support
* lisp/use-package/use-package-core.el (use-package-keywords): Add :vc.
(use-package-handler/:load-path): Insert 'load-path' into 'state'.
(use-package-vc-install): Install the package with package-vc.el.
(use-package-handler/:vc): Handler for the :vc keyword.
(use-package-normalize--vc-arg): Normalization for more complex
arguments to 'use-package-normalize/:vc', in order to make them
compatible with the specification of 'package-vc-selected-packages'.
(use-package-normalize/:vc): Normalizer for the :vc keyword.
(use-package): Document :vc.
* lisp/use-package/use-package-ensure.el (use-package-handler/:ensure):
Do not ensure a package when :vc is used in the declaration.
* test/lisp/use-package/use-package-tests.el (use-package-test/:vc-1):
(use-package-test/:vc-2):
(use-package-test/:vc-3):
(use-package-test/:vc-4):
(use-package-test/:vc-5):
(use-package-test-normalize/:vc):
Add tests for :vc.
* etc/NEWS: Mention change.  (Bug#60418)
2023-05-16 21:22:05 +02:00
Eli Zaretskii
cae528457c ; Add 2023 to copyright years. 2023-01-01 05:31:12 -05:00
Kévin Le Gouguec
01acecc79c Simplify introduction of use-package manual
* doc/misc/use-package.texi (Getting Started): Do not advise requiring
the package, since the macro is autoloaded; also correct the macro's
name.  (Bug#60366)
2022-12-31 10:48:48 +01:00
Stefan Kangas
06ef030f93 use-package.texi: New section "Manual installation"
* doc/misc/use-package.texi (Manual installation): New section.
(Load path, Manual autoloads): Make into subsections of above new
section.
2022-12-12 08:45:40 +01:00
Stefan Kangas
f221105723 ; * doc/misc/use-package.texi: Prepare for GNU ELPA. 2022-12-11 03:14:11 +01:00
Stefan Kangas
a9037aa8e8 ; Fix use-package-ensure-system-package macOS footnote
* doc/misc/use-package.texi (use-package-ensure-system-package): Fix
macOS footnote.
2022-12-11 00:31:40 +01:00
Stefan Kangas
29b9aeae32 ; * doc/misc/use-package.texi: Fix misplaced @end group. 2022-12-10 21:25:04 +01:00
Stefan Kangas
2f1269c333 ; Fix some minor issues in use-package.texi
* doc/misc/use-package.texi: Fix some minor issues.
2022-12-10 13:00:46 +01:00
Eli Zaretskii
0bd26abf7f ; * doc/misc/use-package.texi: Fix @file. 2022-12-09 18:21:38 +02:00
Eli Zaretskii
2ea7a357fd ; * doc/misc/use-package.texi: Fix @acronym. 2022-12-09 18:20:04 +02:00
Eli Zaretskii
f626b9f385 ; * doc/misc/use-package.texi: Fix indexing. 2022-12-09 16:50:13 +02:00
Eli Zaretskii
acd462b030 ; Improve the use-package manual
* doc/misc/use-package.texi (Top, Basic Concepts)
(Getting Started, Loading Packages, Loading basics)
(Deferring loading, Forcing loading, Conditional loading)
(Loading sequentially, Load dependencies, Load path)
(Manual autoloads, Configuring Packages, Lisp Configuration)
(Preface keyword, Init keyword, Best practices, Key bindings)
(Global keybindings, Binding in keymaps, Binding to a keymap)
(Binding to repeat-maps, Displaying keybindings)
(Modes and interpreters, Magic handlers, User options, Faces)
(Delight, Diminish, Install package, Pinning packages)
(Other package managers, Byte-compiling, Troubleshooting)
(Troubleshooting Options, Gathering Statistics)
(Disabling a package, Keyword extensions)
(use-package-ensure-system-package, Creating an extension): Fix
wording, punctuation, typos, and markup; add indexing.  Add
@group..@end group in code examples.
2022-12-09 16:32:59 +02:00
Stefan Kangas
5b640f0abd Improve :delight keyword example in use-package manual
* use-package.texi (Diminish, Delight): Clarify what happens if the
pre-requisite packages are not installed.  Change an example with
performance issues to one without any.

Resolves https://github.com/jwiegley/use-package/issues/835
2022-12-09 06:27:46 +01:00
Stefan Kangas
a17a6036dd Add conditional loading examples to use-package manual
* doc/misc/use-package.texi (Conditional loading): Expand section with
examples.

Resolves https://github.com/jwiegley/use-package/issues/693
2022-12-09 04:15:50 +01:00
Stefan Kangas
15dda8cd5b ; Don't say to require bind-key in use-package manual
* doc/misc/use-package.texi (Getting Started): Remove instruction to
require 'bind-key'; it is already required by 'use-package' and the
entry points are autoloaded.
2022-12-09 00:32:19 +01:00
Stefan Kangas
4be96c9dcb Drop key-chord.el support from use-package
* lisp/use-package/bind-chord.el:
* lisp/use-package/use-package-chords.el:
* test/lisp/use-package/use-package-chords-tests.el: Delete files.
* doc/misc/use-package.texi (use-package-chords): Delete section.
Ref: https://lists.gnu.org/r/emacs-devel/2022-12/msg00052.html
2022-12-08 17:00:29 +01:00
Stefan Kangas
d3e9bd3b57 ; Document use-package-reset-statistics
* doc/misc/use-package.texi (Gathering Statistics): Document
use-package-reset-statistics.
2022-12-08 06:36:44 +01:00
Stefan Kangas
141fe8b827 use-package: Improve :mode keyword documentation
* doc/misc/use-package.texi (Modes and interpreters): Improve
section and document the use of a list of regexps.

Resolves https://github.com/jwiegley/use-package/issues/996
2022-12-08 05:27:59 +01:00
Stefan Kangas
537f11f8cd ; * doc/misc/use-package.texi: Improve indexing. 2022-12-08 01:49:04 +01:00
Stefan Kangas
98e54f597e Add new use-package manual
* doc/misc/use-package.texi: Rewrite manual.
2022-12-08 00:47:04 +01:00
John Wiegley
3e81af80a2 Revert "Allow multiple keymaps in :map argument" 2022-11-15 15:24:12 -08:00
John Wiegley
49fffe7cf4 Merge remote-tracking branch 'origin/master' into pr-830 2022-11-15 09:21:07 -08:00
John Wiegley
2efc869866 Merge branch 'master' into texinfo-wip 2022-11-15 08:22:04 -08:00
Stefan Kangas
8cf8631c69 Fix makeinfo warnings
Resolves https://github.com/jwiegley/use-package/issues/962
2022-11-15 09:41:47 +01:00
Stefan Kangas
a6b1b62763 Use two spaces to end sentences 2022-11-15 09:21:22 +01:00
Stefan Kangas
6a26c55d70 Recommend GNU ELPA over MELPA 2022-11-15 08:54:56 +01:00
Stefan Kangas
4e8b72efc8 manual: Regenerate texi file 2022-11-15 08:14:47 +01:00
Jonas Bernoulli
835fdb16be manual: Regenerate texi file 2022-08-08 13:28:32 +02:00
Damien Cassou
30b35d6d62 Update use-package.texi 2022-04-04 21:10:44 +02:00
John Wiegley
99643f8873 Update version to 2.4.1 2020-11-10 13:33:45 -08:00
Damien Cassou
3a58f53b14 Fix typos
Typos found with codespell.
2019-11-26 21:28:51 +01:00
John Wiegley
b1d9ce08a6 Update use-package.texi 2018-06-13 13:49:00 -07:00
Thomas Ingram
b84a77bcdc Added an Introduction taken from the README
Copyright-paperwork-exempt: yes
2018-06-13 16:24:23 -04:00
Valentin Ignatev
8a27cd3a8b Encourage installation via https instead of http 2018-03-14 21:27:09 +10:00
John Wiegley
1e42c867b6 Commit .texi file, as it requires several dependencies to generate 2017-12-04 12:11:59 -08:00