summaryrefslogtreecommitdiff
path: root/doc/lispref
Commit message (Collapse)AuthorAgeFilesLines
...
* 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 'use-dialog-box-p' and friendsEli Zaretskii2023-05-231-14/+16
| | | | | | | | | | | | | | | * lisp/subr.el (use-dialog-box-p): Use dialog boxes also when invoked from some window-system gesture. (Bug#63655) (y-or-n-p): Fix the description in the doc string of conditions under which a dialog box will be used. * src/fns.c (Fyes_or_no_p): Use the same condition for dialog boxes as in 'use-dialog-box-p'. Fix the description in the doc string of conditions under which a dialog box will be used. * doc/lispref/minibuf.texi (Multiple Queries, Yes-or-No Queries): Fix the description of conditions under which a dialog box will be used.
* ; Fix markup of some treesit vars in Elisp manual.Basil L. Contovounesios2023-05-222-8/+8
| | | | | | | * doc/lispref/modes.texi (Parser-based Font Lock): (Parser-based Indentation): * doc/lispref/parsing.texi (Multiple Languages): Use @code in place of @var when the argument is not a metavariable.
* ; Minor fixes in ELisp manualEli Zaretskii2023-05-141-0/+7
| | | | | | * doc/lispref/functions.texi (Declare Form): Improve indexing. (Obsolete Functions): Add cross-reference. `
* Merge branch 'scratch/long-lines-cleanup' into 'emacs-29'Gregory Heytings2023-05-131-0/+1
|\
| * Code cleanup for long line optimizationsGregory Heytings2023-03-291-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | This commit does not change any code, it merely renames functions and clarifies the documentation, to make the code hopefully easier to grasp. * src/dispextern.h (struct it): Rename the 'narrowed_begv', 'narrowed_zv', 'locked_narrowing_begv', 'locked_narrowing_zv' to 'medium_narrowing_begv', 'medium_narrowing_zv', 'large_narrowing_begv', 'large_narrowing_zv'. Clarify the comments. Update the prototypes of the functions renamed in xdisp.c. * src/lisp.h: Update the prototypes of the functions renamed in editfns.c. Remove the prototype of 'safe_run_hooks_maybe_narrowed', which is used only in keyboard.c. * src/xdisp.c (get_small_narrowing_begv): Renamed from 'get_closer_narrowed_begv'. (get_medium_narrowing_begv): Renamed from 'get_narrowed_begv'. (get_medium_narrowing_zv): Renamed from 'get_narrowed_zv'. (get_large_narrowing_begv): Renamed from 'get_locked_narrowing_begv'. (get_large_narrowing_zv): Renamed from 'get_locked_narrowing_zv'. (SET_WITH_NARROWED_BEGV): Use the new field names. (handle_fontified_prop): Use the new function and new field names. (back_to_previous_line_start): Use the new field name. (back_to_previous_visible_line_start): Use the new field name. (reseat): Use the new function and new field names. (get_visually_first_element): Use the new field name. (move_it_vertically_backward): Use the new function name. (redisplay_internal): Use the new function name. Also add a large comment to explain how Emacs deals with long lines. * src/keyboard.c: (safe_run_hooks_maybe_narrowed): Use the new function names from xdisp.c and editfns.c. Make the function static, and add a prototype. * src/editfns.c: (labeled_restrictions): Renamed from 'narrowing_locks'. (labeled_restrictions_add): Renamed from 'narrowing_locks_add'. (labeled_restrictions_remove): Renamed from 'narrowing_locks_remove'. (labeled_restrictions_get_bound): Renamed from 'narrowing_lock_get_bound'. (labeled_restrictions_peek_label): Renamed from 'narrowing_lock_peek_tag'. (labeled_restrictions_push): Renamed from 'narrowing_lock_push'. (labeled_restrictions_pop): Renamed from 'narrowing_lock_pop'. (unwind_reset_outermost_restriction): Renamed from 'unwind_reset_outermost_narrowing'. (reset_outermost_restrictions): Renamed from 'reset_outermost_narrowings'. (labeled_restrictions_save): Renamed from 'narrowing_locks_save'. (labeled_restrictions_restore): Renamed from 'narrowing_locks_restore'. (unwind_labeled_narrow_to_region): Renamed from 'unwind_narrow_to_region_locked'. (labeled_narrow_to_region): Renamed from 'narrow_to_region_locked'. (Finternal__label_restriction): Renamed from 'Finternal__lock_narrowing'. (Finternal__unlabel_restriction): Renamed from 'Finternal__unlock_narrowing'. (Fwiden): Use the new function names. (Fnarrow_to_region): Use the new function names. (save_restriction_save): Use the new function names. (syms_of_editfns): Use the new function names. <outermost-restriction>: Renamed from 'outermost-narrowing'. * lisp/subr.el (internal--with-restriction): Use the new internal function name. (internal--without-restriction): Use the new internal function name. * src/composite.c (composition_compute_stop_pos): (find_automatic_composition): Use the new function name. * doc/lispref/positions.texi (Narrowing): Add index entry.
* | ; Fix example in ELisp manualEli Zaretskii2023-05-101-1/+1
| | | | | | | | | | * doc/lispref/minibuf.texi (Yes-or-No Queries): Fix example. (Bug#63399)
* | ; Updated Elispref-Manual: `nil' cannot be defun'edShynur2023-05-061-1/+1
| | | | | | | | | | * doc/lispref/functions.texi (Function Cells): Fix inaccuracy. (Bug#62746)
* | Clarify documentation wrt floating point division by zero and NaNPo Lu2023-05-041-13/+26
| | | | | | | | | | | | * doc/lispref/numbers.texi (Float Basics) (Arithmetic Operations): Document what happens on a VAX. Tested on NetBSD 9.3.
* | ; Minor grammar fix in treesit manual.Basil L. Contovounesios2023-05-041-1/+1
| |
* | Note that Emacs pauses when handling sentinel errorsSpencer Baugh2023-05-021-2/+6
| | | | | | | | | | | | | | | | | | | | Noting this behavior and variable here makes it easier to understand the behavior of Emacs when a sentinel has an error. * doc/lispref/processes.texi (Filter Functions): Note that Emacs pauses when handling sentinel errors. (Sentinels): Note that Emacs pauses when handling sentinel errors. (Bug#63096)
* | Improve documentation of warningsEli Zaretskii2023-04-303-86/+135
| | | | | | | | | | | | | | | | | | * doc/lispref/control.texi (Errors): * doc/lispref/os.texi (Startup Summary): * doc/lispref/display.texi (Warning Basics, Warning Variables) (Warning Options, Delayed Warnings): Improve documentation of warnings. Document the automatic delaying of warnings during startup. (Bug#63181)
* | Fix documentation of libxml-parse-* functionsEli Zaretskii2023-04-291-3/+5
| | | | | | | | | | | | | | * doc/lispref/text.texi (Parsing HTML/XML): * src/xml.c (Flibxml_parse_html_region, Flibxml_parse_xml_region): Update the documentation regarding the use of BASE-URL argument. (Bug#63125)
* | Document the 'end-session' event on MS-WindowsEli Zaretskii2023-04-251-0/+11
| | | | | | | | | | * doc/lispref/commands.texi (Misc Events): Document the 'end-session' event. (Bug#63058)
* | Fix typo and inaccuracy in the ELisp Reference manualShynur2023-04-182-4/+5
| | | | | | | | | | | | | | | | | | * doc/lispref/loading.texi (Dynamic Modules): Fix a typo. * doc/lispref/customize.texi (Group Definitions): Faces are also in the 'custom-group' property of a customization group. (Bug#62887) Copyright-paperwork-exempt: yes
* | Fix description of lexical environment's internalsEli Zaretskii2023-04-181-7/+10
| | | | | | | | | | | | * doc/lispref/variables.texi (Lexical Binding): Update the description of how the lexical environment is represented internally. (Bug#62840)
* | Update manual about `sort`Mattias EngdegÄrd2023-04-111-27/+25
| | | | | | | | | | | | | | | | | | * doc/lispref/sequences.texi (Sequence Functions): Remove inaccurate and over-specific claims about how `sort` works for lists: there is no guarantee that it doesn't modify the `car` fields of the input list (which is precisely what it does at this time). (cherry picked from commit c753a9592345e2084d69e9e2cc458c16db2e4141)
* | ; Improve documentation of 'match-buffers'Eli Zaretskii2023-04-101-11/+13
| | | | | | | | | | | | * doc/lispref/buffers.texi (Buffer List): * lisp/subr.el (match-buffers): Fix documentation of 'buffer-match-p' and 'match-buffers'.
* | ; doc/lispref/windows.texi: Fix @pxref paren.Basil L. Contovounesios2023-04-091-1/+1
| |
* | Improve the documentation of the XDS supportEli Zaretskii2023-04-081-23/+65
| | | | | | | | | | | | | | | | | | | | | | | | | | * doc/lispref/frames.texi (Drag and Drop): Rephrase and rearrange the documentation of XDS support. Add indexing. Document 'x-dnd-save-direct' and 'x-dnd-save-direct-immediately'. Original patch from Po Lu <luangruo@yahoo.com>. * lisp/x-dnd.el (x-dnd-types-alist, x-dnd-test-function) (x-dnd-default-test-function, x-dnd-direct-save-function): Doc fixes. (x-dnd-save-direct, x-dnd-save-direct-immediately): Rename the second argument to FILENAME. Doc fix.
* | Improve documentation of image-related commandsEli Zaretskii2023-04-081-12/+18
| | | | | | | | | | | | | | | | | | | | | | | | | | | | * lisp/image.el (image-map): Make it inherit from 'image-slice-map' instead of repeating the bindings. * doc/emacs/files.texi (Image Mode): Document the key bindings set by 'insert-image'. Add indexing. * doc/lispref/display.texi (Showing Images): Make the description of user commands more concise. Add index entries and cross-reference to the Emacs manual. * etc/NEWS: Rearrange entries relevant to image commands.
* | ; Improve documentation of 'declare-function'Eli Zaretskii2023-04-051-7/+8
| | | | | | | | | | | | * doc/lispref/functions.texi (Declaring Functions): * lisp/subr.el (declare-function): Document explicitly that ARGLIST argument, if provided, should include the parentheses.
* | ; Fix description of new 'keymap-*' functionsEli Zaretskii2023-04-051-8/+11
| | | | | | | | | | | | | | * doc/lispref/keymaps.texi (Prefix Keys): Fix example (bug#62673). (Functions for Key Lookup): Clarify the possible values of KEYMAP argument of 'keymap-lookup'. (Active Keymaps): Fix typo in function name; add cross-reference.
* | Another terminology fix in ELisp reference manualEli Zaretskii2023-04-042-4/+4
| | | | | | | | | | | | * doc/lispref/frames.texi (Mouse Tracking): * doc/lispref/commands.texi (Motion Events, Event Examples): 'track-mouse' is a macro, not a special form.
* | Correct terminology in Elisp Reference ManualShynur2023-04-041-2/+2
| | | | | | | | | | | | | | * doc/lispref/functions.texi (Function Names): 'defun' is a macro, not a special form. (Bug#62661) Copyright-paperwork-exempt: yes
* | Document enhancements in handling of echo-area messagesEli Zaretskii2023-04-011-17/+57
| | | | | | | | | | | | | | | | | | * etc/NEWS: * doc/lispref/display.texi (Displaying Messages): * lisp/minibuffer.el (inhibit-message-regexps) (set-message-functions, inhibit-message, set-multi-message): Improve the documentation of functions dealing with display of echo-area messages.
* | ; Clarify documentation of 'cursor' text propertyEli Zaretskii2023-03-301-12/+13
| | | | | | | | | | | | * doc/lispref/text.texi (Special Properties): Clarify that 'cursor' property is only considered when the overlay hides buffer text on display. (Bug#62540)
* | Improve documentation of 'defcustom's :set keywordEli Zaretskii2023-03-301-1/+8
|/ | | | | | * lisp/custom.el (defcustom): * doc/lispref/customize.texi (Variable Definitions): Improve the documentation of the :set keyword in 'defcustom'.
* Improve documentation of 'read-choice' and related symbolsEli Zaretskii2023-03-281-8/+17
| | | | | | | * doc/lispref/commands.texi (Reading One Event): * lisp/subr.el (read-char-choice-use-read-key, read-char-choice) (read-char-choice-with-read-key, y-or-n-p-use-read-key): Improve documentation of these functions and variables.
* * doc/lispref/modes.texi: Improve docs for obsolete '%m' constructPhil Sainty2023-03-271-4/+7
| | | | Bug #57080.
* Improve docs for global-mode-string / %M constructPhil Sainty2023-03-261-10/+15
| | | | | * src/xdisp.c (global-mode-string): Update docstring. * doc/lispref/modes.texi: Update manual.
* ; Improve documentation of :predicate in globalized minor modesEli Zaretskii2023-03-231-14/+22
| | | | | | | * doc/lispref/modes.texi (Defining Minor Modes): * lisp/emacs-lisp/easy-mmode.el (define-globalized-minor-mode): Improve documentation of the :predicate keyword in defining globalized minor modes.
* Improve docstring of treesit-parent-while (bug#62301)Yuan Fu2023-03-211-8/+14
| | | | | | * doc/lispref/parsing.texi (Retrieving Nodes): Improve and fix docstring for treesit-parent-until and treesit-parent-while. * lisp/treesit.el (treesit-parent-while): Improve docstring.
* Expand defvar-keymap documentationRobert Pluim2023-03-211-0/+61
| | | | * doc/lispref/keymaps.texi (Creating Keymaps): Describe the :repeat keyword.
* Warn package authors away from keymap-unset with REMOVERobert Pluim2023-03-201-0/+6
| | | | | * doc/lispref/keymaps.texi (Changing Key Bindings): Ask package authors to not use the REMOVE argument to `keymap-unset'.
* Improve warning about changing the string returned by symbol-nameGregory Heytings2023-03-191-3/+2
| | | | | | * src/data.c (Fsymbol_name): Add warning. See bug#62009. * doc/lispref/symbols.texi (Creating Symbols): Improve warning.
* ; Minor copyedits of recent changes in ELisp reference manualEli Zaretskii2023-03-181-3/+3
| | | | | * doc/lispref/keymaps.texi (Changing Key Bindings): Fix wording and markup.
* ; Fix markup in previous changeRobert Pluim2023-03-171-11/+12
|
* Document `keymap-unset' in lisprefRobert Pluim2023-03-171-0/+11
| | | | | * doc/lispref/keymaps.texi (Changing Key Bindings): Document keymap-unset.
* ; Minor wording fix in ELisp reference manualEli Zaretskii2023-03-161-7/+8
| | | | | * doc/lispref/objects.texi (General Escape Syntax): More accurate wording. Avoid non-ASCII characters in Texinfo. (Bug#62224)
* Remove mention of old dotted-list reader quirk from manualMattias EngdegÄrd2023-03-121-7/+0
| | | | | * doc/lispref/objects.texi (Dotted Pair Notation): The (. X) reader peculiarity is no more (bug#62020).
* ; One more improvement to ELisp "internals" appendix.Eli Zaretskii2023-03-111-1/+2
|
* ; Minor improvement of documentation of GC thresholdsEli Zaretskii2023-03-111-4/+6
| | | | | * doc/lispref/internals.texi (Garbage Collection): More practical aspects of enlarging the GC threshold.
* Fix documentation of the 'line-height' text propertyEli Zaretskii2023-03-081-5/+8
| | | | | | * doc/lispref/display.texi (Line Height): More accurate documentation of the value t of 'line-height' text property. (Bug#62048)
* Fix empty line indentation in c-ts-mode (bug#61997)Yuan Fu2023-03-071-0/+3
| | | | | | | | | | * lisp/progmodes/c-ts-mode.el: (c-ts-mode--indent-styles): Handle the empty line case. * test/lisp/progmodes/c-ts-mode-resources/indent.erts: New test. * doc/lispref/modes.texi (Parser-based Indentation): Update manual. * lisp/treesit.el (treesit-simple-indent-presets): Support null as a value for NODE-TYPE in the 'match' matcher.
* Change tree-sitter indent anchor 'point-min' to 'column-0'Yuan Fu2023-03-041-3/+3
| | | | | | | | | | | | | | Point-min isn't necessarily at column 0, using line-beginning-position is better. column-0 is also more intuitive. * doc/lispref/modes.texi (Parser-based Indentation): Update manual. * lisp/progmodes/c-ts-mode.el (c-ts-mode--indent-styles): * lisp/progmodes/java-ts-mode.el (java-ts-mode--indent-rules): * lisp/progmodes/rust-ts-mode.el (rust-ts-mode--indent-rules): * lisp/progmodes/typescript-ts-mode.el: (typescript-ts-mode--indent-rules): Change point-min to column-0. * lisp/treesit.el (treesit-simple-indent-presets): Change point-min to column-0.
* ; More doc improvements for OClosuresEli Zaretskii2023-03-032-4/+9
| | | | | | * doc/lispref/functions.texi (OClosures): * doc/lispref/commands.texi (Using Interactive): * etc/NEWS: Some more docs improvements for OClosures.
* Minor copyedits of documentation of OClosuresEli Zaretskii2023-03-032-53/+97
| | | | | * doc/lispref/functions.texi (OClosures): Improve wording, indexing, and markup; add details.
* Rename the newly added -ref- faces to -use-Dmitry Gutov2023-02-281-4/+4
| | | | | | * lisp/font-lock.el (font-lock-variable-use-face) (font-lock-property-use-face): Rename from font-lock-variable-ref-face and font-lock-property-ref-face. Update all references (bug#61655).