summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* ; * doc/misc/eshell.texi: Fix typos and clean up unclear wording.Jim Porter2023-07-131-38/+39
| | | | Do not merge to master. This is a backport of 118582efb30.
* Document some missing Eshell commandsJim Porter2023-07-131-0/+24
| | | | | | | Do not merge to master. This is a backport of f7a899d7ca0. * doc/misc/eshell.texi (Built-ins): Document 'eshell-debug'. (Extra built-in commands): Document 'count', 'ff', and 'gf'.
* Document optional Eshell modulesJim Porter2023-07-131-83/+128
| | | | | | | | | | Do not merge to master. This is a backport of 77f13edab0f. * 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!
* Correct the Eshell documentation about how to write new modulesJim Porter2023-07-131-13/+17
| | | | | | | * 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 77f13edab0f.
* Restructure Eshell extension modules documentationJim Porter2023-07-131-42/+44
| | | | | | | | | | | | | | | | | This adds a section for documenting all the optional modules. Do not merge to master. This is a backport of f2981a1681d. * 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.
* ; * doc/misc/eshell.texi (Bugs and ideas): Remove implemented feature.Jim Porter2023-07-131-2/+0
| | | | Do not merge to master. This is a backport of 194de36ca9f.
* Replace duplicate text from epa.texi by a referenceJens Schmidt2023-07-131-37/+6
| | | | | | * doc/misc/auth.texi (GnuPG and EasyPG Assistant Configuration): Replace duplicate text from epa.texi by a reference to that. (Bug#64154)
* Add basic usage information and fix referencesJens Schmidt2023-07-131-41/+175
| | | | | | | | | | | | | | * 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)
* Add concept index, title-case structure titlesJens Schmidt2023-07-131-11/+66
| | | | | | | | | | * 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)
* ; * doc/misc/modus-themes.org: Fix whitespace (bug#64548).Stephen Berman2023-07-111-20/+20
|
* ; Improve documentation of with-restrictionGregory Heytings2023-07-091-1/+2
| | | | | | | * 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.
* ; * doc/lispref/keymaps.texi (Key Binding Commands): Fix typo.Eli Zaretskii2023-07-071-1/+1
|
* ; Improve documentation of 'vertical-motion' in ELisp manualEli Zaretskii2023-07-071-10/+17
| | | | | * doc/lispref/positions.texi (Screen Lines): Improve the documentation of 'vertical-motion'.
* ; Improve documentation of key-binding commandsEli Zaretskii2023-07-061-1/+10
| | | | | | | | | * 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.
* correct info documentation of benchmark-callRobert Pluim2023-07-041-3/+3
| | | | | * doc/lispref/debugging.texi (Profiling): 'benchmark-call' is a defun, not a macro.
* ; Fix documentation of minibuffer-completion commandsEli Zaretskii2023-07-031-6/+15
| | | | | * doc/emacs/mini.texi (Completion Commands): Index more keys and commands. (Bug#64425)
* ; Fix typos in documented names of keymap-* functionsEli Zaretskii2023-07-031-2/+2
| | | | | * doc/lispref/keymaps.texi (Functions for Key Lookup): Fix typos in function names. (Bug#64434)
* Avoid errors in completion due to 'completion-regexp-list'Eli Zaretskii2023-07-021-0/+6
| | | | | | | | | | * 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)
* ; Fix two typos in recent changes in the manualMichael Heerdegen2023-07-021-1/+1
| | | | | * doc/lispref/text.texi (Property Search): * lisp/register.el (register-preview-function): Fix typos.
* ; Improve documentation of text-property-search-* functionsEli Zaretskii2023-07-011-22/+29
| | | | | | | * 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)
* ; Fix @xref in last change to doc/emacs/regs.texi.Basil L. Contovounesios2023-06-301-1/+1
|
* ; Fix tree-sitter C binding typos in Elisp manual.Basil L. Contovounesios2023-06-301-3/+3
|
* Improve documentation of registersEli Zaretskii2023-06-303-16/+28
| | | | | | | | | | | | | | | * 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)
* ; * doc/lispref/variables.texi: Fix define-obsolete-variable-alias arglistVladimir Sedach2023-06-271-1/+1
| | | | | | The WHEN argument is not optional anymore (bug#64312) Copyright-paperwork-exempt: yes
* ; Document that 'named-let' needs lexical-bindingEli Zaretskii2023-06-261-0/+3
| | | | | * doc/lispref/variables.texi (Local Variables): Warn that 'named-let' only works under lexical-binding. (Bug#64290)
* ; * doc/emacs/package.texi (Fetching Package Sources): Fix typo (bug#64282).Eli Zaretskii2023-06-251-1/+1
|
* ; Fix typo in maintaining.texi (bug#64279)Eshel Yaron2023-06-251-1/+1
| | | | * doc/emacs/maintaining.texi (Log Buffer): Fix a typo.
* ; * doc/lispintro/emacs-lisp-intro.texi (car & cdr): Fix typo.Eli Zaretskii2023-06-251-1/+1
| | | | (cherry picked from commit 0ebedd0119c1bc3c1f55e873385a01e97f102766)
* Clarify list terminologyRichard M. Stallman2023-06-251-20/+35
| | | | | | | | | | * 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 188c90c7c111dbbdc3edd29c23b59ade26f97bfd)
* Improve documentation of 'minibuffer-message'Eli Zaretskii2023-06-201-7/+17
| | | | | | | | | | * 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)
* Describe primarily the Emacs s-exp dialect for treesit queriesMattias Engdegård2023-06-181-66/+66
| | | | | | | | * 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).
* ; Improve documentation of overlay prioritiesEli Zaretskii2023-06-181-23/+32
| | | | | | * doc/lispref/display.texi (Overlay Properties): Don't advise against using overlay property values that are cons cells. (Bug#64101)
* Fix documentation of :predicate in 'define-globalized-minor-mode'Eli Zaretskii2023-06-181-5/+8
| | | | | | | * 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)
* ; * doc/lispref/display.texi (Display Tables): Remove extra parens.Eli Zaretskii2023-06-171-1/+1
|
* Fix documentation of comment-dwim (bug#64104)Eli Zaretskii2023-06-171-8/+11
| | | | | | | * 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.
* ; Fix example in the Flymake manualEli Zaretskii2023-06-171-0/+9
| | | | | * doc/misc/flymake.texi (An annotated example backend): Fix the example. (Bug#64070)
* * doc/misc/calc.texi (Advanced Math Functions): Correct calcAndreas Schwab2023-06-151-5/+5
| | | | algebraic syntax.
* ; Fix use-package.texi markupRobert Pluim2023-06-151-1/+1
| | | | | * doc/misc/use-package.texi (Best practices): It's a subsection, not a subheading.
* ; * doc/misc/calc.texi (Advanced Math Functions): Fix last change.Eli Zaretskii2023-06-151-1/+1
|
* Fix Gamma function definition in calc.texiEli Zaretskii2023-06-151-6/+6
| | | | | * doc/misc/calc.texi (Advanced Math Functions): Fix definition of Gamma function. Use @sup in @infoline lines. (Bug#64077)
* Fix subscripts in the Calc manualEli Zaretskii2023-06-151-3/+3
| | | | | | * doc/misc/calc.texi (Musical Notes): Use @sub instead of TeX-only '_' notation. For the details, see the discussion in https://lists.gnu.org/archive/html/emacs-devel/2023-06/msg00096.html.
* Improve documentation of 'declare' formsEli Zaretskii2023-06-151-6/+10
| | | | | | | | | * lisp/simple.el (read-extended-command-predicate): Mention the '(declare completion ...' form in the doc string. * doc/lispref/functions.texi (Declare Form): Clarify 'completion-predicate' and 'modes'; add cross-references. (Bug#64045)
* Improve tree-sitter docsBasil L. Contovounesios2023-06-133-201/+227
| | | | | | | | | | | | | | | | | | | | | | | * doc/lispref/positions.texi (List Motion): Incorporate more accurate description of treesit-defun-type-regexp from '(elisp) Tree-sitter Major Modes', replacing that duplicate entry (bug#64018). * doc/lispref/parsing.texi (Parsing Program Source) (Language Grammar, Using Parser, Retrieving Nodes) (Accessing Node Information, Pattern Matching, Multiple Languages): (Tree-sitter Major Modes): * doc/lispref/modes.texi (Parser-based Font Lock): Improve wording, grammar, punctuation, and markup. Fix typos. (Parser-based Indentation): Ditto. Document indent rule presets field-is, catch-all, nth-sibling, grand-parent, and great-grand-parent. * lisp/treesit.el (treesit-simple-indent-presets): Mention field-is, catch-all, nth-sibling, grand-parent, great-grand-parent in docstring. (treesit-major-mode-setup, treesit-explore-mode): Improve docstring/commentary grammar.
* Fix some Texinfo markup in manualsBasil L. Contovounesios2023-06-1321-118/+124
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * doc/emacs/macos.texi (Mac / GNUstep Customization): * doc/lispintro/emacs-lisp-intro.texi (condition-case): * doc/lispref/control.texi (pcase Macro): * doc/lispref/debugging.texi (Internals of Debugger): * doc/lispref/internals.texi (Building Emacs): * doc/lispref/modes.texi (Imenu): (Parser-based Font Lock, Parser-based Indentation): * doc/lispref/parsing.texi (Retrieving Nodes, Tree-sitter C API): * doc/lispref/processes.texi (Network, Bindat Types): * doc/lispref/searching.texi (Rx Functions): * doc/lispref/text.texi (Replacing): * doc/lispref/windows.texi (Textual Scrolling): * doc/misc/calc.texi (Killing From Stack, Customizing Calc): * doc/misc/cc-mode.texi (Misc Font Locking, List Line-Up): * doc/misc/ede.texi (ede-cpp-root-project) (ede-proj-target-makefile, ede-sourcecode): * doc/misc/ert.texi (Running Tests in Batch Mode): * doc/misc/eudc.texi (Emacs-only Configuration, The Server Hotlist): * doc/misc/eww.texi (Advanced): * doc/misc/flymake.texi (Starting Flymake) (Proc customization variables): * doc/misc/tramp.texi (File name completion): * doc/misc/gnus.texi (Summary Buffer Lines, Gnus Registry Setup) (Fancy splitting to parent, Customizing the IMAP Connection) (Mail Source Specifiers, Agent as Cache): Consistently mark up nil and t as @code. Also fix the markup and wording of some surrounding text (bug#64016). * doc/lispref/display.texi (SVG Images, Icons): * doc/lispref/modes.texi (Customizing Keywords): Prefer ASCII apostrophe over Unicode right single quotation mark.
* Fix setting $DBUS_SESSION_BUS_ADDRESS after Emacs has startedMichael Albinus2023-06-121-2/+18
| | | | | | | * doc/misc/dbus.texi (Alternative Buses): Explain using $DBUS_SESSION_BUS_ADDRESS after Emacs has started. * src/dbusbind.c (XD_DBUS_VALIDATE_BUS_ADDRESS): Use egetenv.
* ; * doc/emacs/indent.texi (Indentation Commands): Fix last change.Eli Zaretskii2023-06-101-1/+1
|
* Mention indent-rigidly in the Emacs manualDaniel Martín2023-06-101-2/+2
| | | | | | * doc/emacs/indent.texi (Indentation Commands): Rewrite the first sentence of 'C-x TAB' to mention the command that it executes, and without using passive voice. (Bug#63997)
* Improve documentation of color-related functionsEli Zaretskii2023-06-091-0/+14
| | | | | * doc/lispref/frames.texi (Color Names): Document 'color-name-to-rgb' and 'color-dark-p'.
* Document 'startup-redirect-eln-cache'Eli Zaretskii2023-06-081-1/+20
| | | | | | | | | * doc/lispref/compile.texi (Native Compilation) (Native-Compilation Functions): Document 'startup-redirect-eln-cache'. * etc/PROBLEMS: Fix last change. * etc/NEWS: Mark 'startup-redirect-eln-cache' as documented.
* Fix typo in calc.texiEli Zaretskii2023-06-031-1/+1
| | | | | * doc/misc/calc.texi (Programming Tutorial): Fix a typo. Suggested by Vladimir Nikishkin <lockywolf@gmail.com>.