1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-27 07:41:28 -08:00
Commit graph

11043 commits

Author SHA1 Message Date
Eli Zaretskii
d172cd5985 ; * doc/lispref/keymaps.texi (Modifying Menus): Add cross-references. 2023-07-18 16:17:15 +03:00
Eli Zaretskii
927e8b470f ; * doc/lispref/keymaps.texi (Extended Menu Items): Add @pxref. 2023-07-18 15:57:01 +03:00
Eli Zaretskii
ea696ea4b9 ; Fix last change. 2023-07-14 20:33:29 +03:00
YugaEgo
b0181dafb9 Improve documentation of 'enable-local-variables' in Emacs manual
* doc/emacs/custom.texi (Safe File Variables): Document ':all'.
(Bug#64621)
2023-07-14 20:30:33 +03:00
Mauro Aranda
eb7c45ca43 ; Fix copy-paste in Widget Manual (Bug#64610) 2023-07-14 14:54:24 +03:00
Eli Zaretskii
aedbc3006e ; * doc/misc/eshell.texi (Aliases): Remove stray "@end table". 2023-07-14 08:32:57 +03:00
Jim Porter
6a360b0840 ; * doc/misc/eshell.texi (Variables): Add missing index for $INSIDE_EMACS
Do not merge to master.  On master, this was fixed by 0bb8a011d5.
2023-07-13 19:24:12 -07:00
Michael Albinus
f529bf52eb ; * doc/misc/eshell.texi (Invocation): Whitespace cleanup.
Do not merge to master.  This is a backport of 04710bd01b.
2023-07-13 19:24:12 -07:00
Jim Porter
3a70354579 Add documentation about remote access in Eshell
Do not merge to master.  This is a backport of 438921161a.

* doc/misc/eshell.texi
(Invocation): Mention the '*' prefix.
(Remote Access): New section...
(Commands): ... link to it.
2023-07-13 19:24:12 -07:00
Jim Porter
7640835ae0 ; * doc/misc/eshell.texi: Fix last change.
Do not merge to master.  This is a backport of 8c5fef4eb3.
2023-07-13 19:24:12 -07:00
Jim Porter
e79306fb46 ; * doc/misc/eshell.texi: Fix typos and clean up unclear wording.
Do not merge to master.  This is a backport of 118582efb3.
2023-07-13 19:24:11 -07:00
Jim Porter
9f6d79dd96 Document some missing Eshell commands
Do not merge to master.  This is a backport of f7a899d7ca.

* doc/misc/eshell.texi (Built-ins): Document 'eshell-debug'.
(Extra built-in commands): Document 'count', 'ff', and 'gf'.
2023-07-13 19:24:11 -07:00
Jim Porter
951671b0e1 Document optional Eshell modules
Do not merge to master.  This is a backport of 77f13edab0.

* doc/misc/eshell.texi (Built-ins): Move disabled-by-default commands
to...
(Tramp extensions, Extra built-in commands): ...here
(Optional modules, Key rebinding, Smart scrolling): Add documentation.
(Bug and ideas): Documentation is no longer incomplete!
2023-07-13 19:24:11 -07:00
Jim Porter
7c417b2ae5 Correct the Eshell documentation about how to write new modules
* doc/misc/eshell.texi (Writing a module): Fix the documentation.
'eshell-defgroup' doesn't exist anymore.

Do not merge to master.  This is a backport of 77f13edab0.
2023-07-13 19:24:11 -07:00
Jim Porter
6c3fe42bde Restructure Eshell extension modules documentation
This adds a section for documenting all the optional modules.

Do not merge to master.  This is a backport of f2981a1681.

* doc/misc/eshell.texi (Extension modules): Move explanation about
writing modules to...
(Writing a module): ... here.
(Module testing): Remove.  Testing an Eshell module doesn't require
any special documentation.
(Key binding, Smart scrolling, Electric forward slash): Move under...
(Optional modules): ... here.
(Directory handling, Terminal emulation): Remove.  These modules are
enabled by default, and so are documented above.
(Tramp extensions, Extra built-in commands): New sections.
2023-07-13 19:24:11 -07:00
Jim Porter
4e204b5618 ; * doc/misc/eshell.texi (Bugs and ideas): Remove implemented feature.
Do not merge to master.  This is a backport of 194de36ca9.
2023-07-13 19:24:11 -07:00
Jens Schmidt
9bc93c7996 Replace duplicate text from epa.texi by a reference
* doc/misc/auth.texi (GnuPG and EasyPG Assistant Configuration):
Replace duplicate text from epa.texi by a reference to
that. (Bug#64154)
2023-07-13 10:51:50 +03:00
Jens Schmidt
74cc1d27f1 Add basic usage information and fix references
* doc/misc/epa.texi (Top): Add menu entry for new node GnuPG Pinentry.
(Quick Start): Add information on and reference to basic GnuPG
configuration.
(Encrypting/decrypting gpg files): Add usage information.
(GnuPG version compatibility): Update version information.
(GnuPG Pinentry): Add new node.
(Caching Passphrases): Describe mandatory gpg-agent usage for GnuPG
2.0 and later.
(Overview, Encrypting/decrypting gpg files, GnuPG version compatibility)
(Caching Passphrases, Bug Reports): Fix references, terminology,
mark-up, and index entries.  (Bug#64154)
2023-07-13 10:51:10 +03:00
Jens Schmidt
f24bdbfaf5 Add concept index, title-case structure titles
* doc/misc/epa.texi (Top, Overview, Commands, Key management)
(Cryptographic operations on regions, Cryptographic operations on files)
(Dired integration, Mail-mode integration)
(Encrypting/decrypting gpg files, Querying a key server)
(GnuPG version compatibility, Caching Passphrases)
(GNU Free Documentation License): Add concept index, title-case
structure titles.  (Bug#64154)
2023-07-13 10:50:00 +03:00
Stephen Berman
4cf33b6bd0 ; * doc/misc/modus-themes.org: Fix whitespace (bug#64548). 2023-07-11 14:09:06 +03:00
Gregory Heytings
419b4d4491 ; Improve documentation of with-restriction
* lisp/subr.el (with-restriction):
* doc/lispref/positions.texi (Narrowing): Make it clear that the
argument is evaluated and that the result of the evaluation must
not be nil.
2023-07-09 19:28:29 +00:00
Eli Zaretskii
40f84e906f ; * doc/lispref/keymaps.texi (Key Binding Commands): Fix typo. 2023-07-07 09:59:52 +03:00
Eli Zaretskii
502a780031 ; Improve documentation of 'vertical-motion' in ELisp manual
* doc/lispref/positions.texi (Screen Lines): Improve the
documentation of 'vertical-motion'.
2023-07-07 09:26:58 +03:00
Eli Zaretskii
a30ebe7a55 ; Improve documentation of key-binding commands
* doc/lispref/keymaps.texi (Key Binding Commands): Improve the
documentation of arguments expected by key binding commands.

* lisp/keymap.el (keymap-set, keymap-global-set)
(keymap-local-set, keymap-global-unset, keymap-local-unset)
(keymap-unset, key-parse): Doc fixes.
2023-07-06 11:42:01 +03:00
Robert Pluim
244d4c837a correct info documentation of benchmark-call
* doc/lispref/debugging.texi (Profiling): 'benchmark-call' is a defun,
not a macro.
2023-07-04 17:35:40 +02:00
Eli Zaretskii
8da2091362 ; Fix documentation of minibuffer-completion commands
* doc/emacs/mini.texi (Completion Commands): Index more keys and
commands.  (Bug#64425)
2023-07-03 16:14:45 +03:00
Eli Zaretskii
aa030698ce ; Fix typos in documented names of keymap-* functions
* doc/lispref/keymaps.texi (Functions for Key Lookup): Fix typos
in function names.  (Bug#64434)
2023-07-03 15:12:12 +03:00
Eli Zaretskii
37ed3d15f3 Avoid errors in completion due to 'completion-regexp-list'
* doc/lispref/minibuf.texi (Basic Completion):
* src/minibuf.c (syms_of_minibuf) <completion-regexp-list>:
Document that global non-nil settings of 'completion-regexp-list'
are not safe.

* lisp/minibuffer.el (completion-pcm--merge-completions): Avoid
errors in 'try-completion' when PREFIX is nil.  (Bug#64351)
2023-07-02 09:16:58 +03:00
Michael Heerdegen
fe7b909c16 ; Fix two typos in recent changes in the manual
* doc/lispref/text.texi (Property Search):
* lisp/register.el (register-preview-function): Fix typos.
2023-07-02 08:23:28 +03:00
Eli Zaretskii
fc6099bf04 ; Improve documentation of text-property-search-* functions
* doc/lispref/text.texi (Property Search): Improve wording and markup.

* lisp/emacs-lisp/text-property-search.el (text-property-search-forward)
(text-property-search-backward): Doc fixes.  (Bug#64367)
2023-07-01 12:28:33 +03:00
Basil L. Contovounesios
0be18d8097 ; Fix @xref in last change to doc/emacs/regs.texi. 2023-06-30 12:21:00 +01:00
Basil L. Contovounesios
624c779517 ; Fix tree-sitter C binding typos in Elisp manual. 2023-06-30 12:04:42 +01:00
Eli Zaretskii
16e9bdff4f Improve documentation of registers
* doc/lispref/text.texi (Registers): Document buffers in
registers.  Mention "frameset" as another name for "frame
configuration".
* doc/emacs/regs.texi (Registers, Configuration Registers)
(File and Buffer Registers): Clarify and improve wording.  Add
cross-references and indexing.
(Configuration Registers): Rename the section to a more accurate
name.  (Bug#64354)

* lisp/register.el (jump-to-register, point-to-register)
(register-alist, frame-configuration-to-register): Doc fixes.
(Bug#64353)
2023-06-30 10:13:53 +03:00
Vladimir Sedach
53332bdf62 ; * doc/lispref/variables.texi: Fix define-obsolete-variable-alias arglist
The WHEN argument is not optional anymore (bug#64312)

Copyright-paperwork-exempt: yes
2023-06-27 14:21:49 +03:00
Eli Zaretskii
162c9c058e ; Document that 'named-let' needs lexical-binding
* doc/lispref/variables.texi (Local Variables): Warn that
'named-let' only works under lexical-binding.  (Bug#64290)
2023-06-26 18:41:06 +03:00
Eli Zaretskii
382f5fa813 ; * doc/emacs/package.texi (Fetching Package Sources): Fix typo (bug#64282). 2023-06-25 17:57:31 +03:00
Eshel Yaron
2aa57fe6cf ; Fix typo in maintaining.texi (bug#64279)
* doc/emacs/maintaining.texi (Log Buffer): Fix a typo.
2023-06-25 09:55:10 +03:00
Eli Zaretskii
1d9200d9bb ; * doc/lispintro/emacs-lisp-intro.texi (car & cdr): Fix typo.
(cherry picked from commit 0ebedd0119)
2023-06-25 08:27:01 +03:00
Richard M. Stallman
987b25d60d Clarify list terminology
* doc/lispintro/emacs-lisp-intro.texi (Lists diagrammed):
Mention "cons cell".  Add index entries.
(car & cdr): Simplify etymology of `car' and `cdr'.
Explain why for some purposes they are better than `first' and `rest'.
Mention cons cells.

(cherry picked from commit 188c90c7c1)
2023-06-25 08:26:20 +03:00
Eli Zaretskii
2591eb1190 Improve documentation of 'minibuffer-message'
* doc/lispref/minibuf.texi (Minibuffer Misc): Clarify that
'minibuffer-message' behaves like 'message' if called from a
buffer that is not a minibuffer.

* lisp/minibuffer.el (minibuffer-message)
(set-minibuffer-message, clear-minibuffer-message): Doc fixes.
(Bug#64165)
2023-06-20 15:31:57 +03:00
Mattias Engdegård
8f62e7b85f Describe primarily the Emacs s-exp dialect for treesit queries
* doc/lispref/parsing.texi (Pattern Matching, Multiple Languages):
Writing tree-sitter queries as Emacs s-expressions is much more
convenient than using the native query notation inside a string,
so it makes sense to base the documentation on the former dialect
(bug#64017).
2023-06-18 10:42:44 +02:00
Eli Zaretskii
eacd75df4e ; Improve documentation of overlay priorities
* doc/lispref/display.texi (Overlay Properties): Don't advise
against using overlay property values that are cons cells.
(Bug#64101)
2023-06-18 09:13:02 +03:00
Eli Zaretskii
b3f11e94fa Fix documentation of :predicate in 'define-globalized-minor-mode'
* doc/lispref/modes.texi (Defining Minor Modes):
* lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode):
Document that :predicate creates a customizable user option.
(Bug#64048)
2023-06-18 08:50:54 +03:00
Eli Zaretskii
aad7d68164 ; * doc/lispref/display.texi (Display Tables): Remove extra parens. 2023-06-17 16:13:38 +03:00
Eli Zaretskii
3b0bf359e9 Fix documentation of comment-dwim (bug#64104)
* lisp/newcomment.el (comment-dwim): Doc fix.

* doc/emacs/programs.texi (Comment Commands): More accurate
description of what 'M-;' does when there's no active region.
2023-06-17 11:37:19 +03:00
Eli Zaretskii
84d2da003e ; Fix example in the Flymake manual
* doc/misc/flymake.texi (An annotated example backend): Fix the
example.  (Bug#64070)
2023-06-17 10:49:45 +03:00
Andreas Schwab
0a1459f1d9 * doc/misc/calc.texi (Advanced Math Functions): Correct calc
algebraic syntax.
2023-06-15 16:27:55 +02: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
Eli Zaretskii
018e4ca6c5 ; * doc/misc/calc.texi (Advanced Math Functions): Fix last change. 2023-06-15 11:38:32 +03:00
Eli Zaretskii
1952dbd4c5 Fix Gamma function definition in calc.texi
* doc/misc/calc.texi (Advanced Math Functions): Fix definition
of Gamma function.  Use @sup in @infoline lines.  (Bug#64077)
2023-06-15 10:39:55 +03:00