1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-19 13:24:44 -07:00
Commit graph

4226 commits

Author SHA1 Message Date
Eli Zaretskii
fd77065fc6 Improve recently added documentation
* doc/lispref/lists.texi (Building Lists):
* lisp/subr.el (ensure-list): Avoid passive tense in documenting
'ensure-list'.
2021-09-21 21:51:38 +03:00
Lars Ingebrigtsen
be4f858498 Add new function `ensure-list'
* doc/lispref/lists.texi (Building Lists): Document it.

* lisp/subr.el (ensure-list): New function.

* lisp/emacs-lisp/shortdoc.el (list): Mention it.
2021-09-21 20:31:05 +02:00
Lars Ingebrigtsen
314f27014e Document `window-bump-use-time'
* doc/lispref/windows.texi (Cyclic Window Ordering): Mention
window-bump-use-time.
2021-09-21 19:48:01 +02:00
Miha Rihtaršič
469b15f27c Improve documentation of exiting recursive editing
* doc/lispref/commands.texi (Recursive Editing): Mention what happens
when throwing a string or any other value to 'exit.
* src/keyboard.c (Frecursive_edit): Document throwing a function
to 'exit (bug#49700).
2021-09-20 08:00:08 +02:00
Juri Linkov
4b3dc7a139 * lisp/subr.el (string-replace): Add dashes to arg names (bug#50644)
* lisp/net/tramp-compat.el (tramp-compat-string-replace): Idem.
* doc/lispref/searching.texi (Search and Replace): Idem.
2021-09-18 21:43:18 +03:00
Lars Ingebrigtsen
928c162673 Mention that the garbage collection is convervative
* doc/lispref/internals.texi (Garbage Collection): Mention that
we're using a conservative gc (bug#42013).
2021-09-17 16:17:08 +02:00
Eli Zaretskii
3848e2727e Improve the documentation of a recent change
* etc/NEWS:
* doc/lispref/sequences.texi (Sequence Functions): Improve
documentation of 'seq-union'.
2021-09-17 15:03:53 +03:00
Stefan Kangas
0cf0a2b986 Add new sequence function 'seq-union'
* lisp/emacs-lisp/seq.el (seq-union): New function.
* doc/lispref/sequences.texi (Sequence Functions):
* lisp/emacs-lisp/shortdoc.el (sequence): Document above new
function.
* test/lisp/emacs-lisp/seq-tests.el (test-seq-union): New test.
2021-09-17 11:03:39 +02:00
Stefan Kangas
bcf59b99f4 Prefer "website" to "homepage"
These days, a "home page" is understood to be only "the main web page
of a website" or "landing page", whereas a "website" is "a collection
of web pages and related content" (Wikipedia).

* doc/emacs/emacs.texi (Top):
* doc/emacs/package.texi (Package Menu):
* doc/lispintro/emacs-lisp-intro.texi (Top):
* doc/lispref/elisp.texi (Top):
* doc/lispref/tips.texi (Documentation Tips):
* doc/misc/ede.texi (ede-project):
* doc/misc/efaq-w32.texi (More information):
* doc/misc/gnus-faq.texi (FAQ 5-7):
* doc/misc/gnus.texi (About mairix):
* doc/misc/mairix-el.texi (About):
* doc/misc/reftex.texi (AUCTeX, Imprint):
* lisp/cedet/ede/base.el (ede-project):
* lisp/cedet/ede/system.el (ede-web-browse-home):
* lisp/emacs-lisp/package.el (package-menu-mode-menu)
(package-browse-url):
* lisp/erc/erc-button.el (erc-emacswiki-url):
* lisp/filesets.el (filesets-goto-homepage):
* lisp/net/mairix.el:
* lisp/net/webjump.el (webjump-sample-sites):
* lisp/obsolete/vc-arch.el:
* lisp/progmodes/idlw-shell.el (idlwave-shell-mode):
* lisp/progmodes/idlwave.el (idlwave, idlwave-mode):
* lisp/textmodes/reftex-vars.el (reftex):
Prefer "website" to "home page".

* doc/lispref/tips.texi (Documentation Tips):
Sort the "URL" header comment before "Homepage".

* lisp/emacs-lisp/lisp-mnt.el
(lm-website): Rename from 'lm-homepage'.
(lm-homepage): Make into alias for 'lm-website'.
2021-09-16 15:42:44 +02:00
Stefan Kangas
7f53446a10 Doc fix for y-or-n-p; trailing space is no longer needed
* doc/lispref/minibuf.texi (Yes-or-No Queries):
* doc/lispref/os.texi (Suspending Emacs):
* doc/lispref/tips.texi (Programming Tips):
* doc/misc/gnus-faq.texi (FAQ 5-9):
* lisp/subr.el (y-or-n-p):
* src/fns.c (Fyes_or_no_p): Doc fix to reflect that a trailing space
is no longer needed; one is added or removed automatically.
2021-09-16 09:38:24 +02:00
Eli Zaretskii
9b50b36efe Documentation followup to a recent commit
* doc/lispref/tips.texi (Documentation Tips): Make the wording of
recommendation not to over-use \\[..] more future-proof.
(Bug#50599)
2021-09-15 22:01:21 +03:00
Eli Zaretskii
83557511a7 Update Unicode support to Unicode version 14.0.0
* admin/unidata/copyright.html:
* admin/unidata/UnicodeData.txt:
* admin/unidata/Blocks.txt:
* admin/unidata/BidiBrackets.txt:
* admin/unidata/BidiMirroring.txt:
* admin/unidata/IVD_Sequences.txt:
* admin/unidata/NormalizationTest.txt:
* admin/unidata/SpecialCasing.txt:
* test/manual/BidiCharacterTest.txt: Updated files from Unicode
14.0.

* lisp/international/fontset.el (script-representative-chars): Add
new scripts.
(otf-script-alist): Update from latest version.
(setup-default-fontset): Add new scripts.
* lisp/international/characters.el: Update syntax and category
tables for new characters and scripts.
(char-width-table): Update for changes in Unicode 14.0.
* lisp/international/mule-cmds.el (ucs-names): Update used and
unused ranges per Unicode 14.0.

* test/lisp/international/ucs-normalize-tests.el
(ucs-normalize-tests--failing-lines-part1)
(ucs-normalize-tests--failing-lines-part2): Update per the test
results.

* doc/lispref/nonascii.texi (Character Properties): Update Unicode
version number.

* etc/NEWS: Announce support for Unicode 14.0.

* admin/notes/unicode: Minor copyedits.
2021-09-15 14:40:13 +03:00
Stefan Monnier
e4a187ca59 * doc/lispref/variables.texi (named-let): Document TCO 2021-09-13 09:14:05 -04:00
Lars Ingebrigtsen
acc575846d Mention how to disable auto-fill-mode in the auto-fill section
* doc/lispref/text.texi (Margins): Mention how to disable
auto-fill-mode.
2021-09-13 12:41:34 +02:00
Lars Ingebrigtsen
893eb0b8a2 Mention `benchmark-call' in the manual
* doc/lispref/debugging.texi (Profiling): Mention `benchmark-call'.
2021-09-13 12:08:58 +02:00
Lars Ingebrigtsen
ba0be8df53 Document named-let and update some NEWS tags
* doc/lispref/variables.texi (Local Variables): Document `named-let'.
2021-09-13 11:53:18 +02:00
Amin Bandali
e4b7fa0500
Merge from origin/emacs-27
d7f4cc0974 ERC: Track: Clarify documentation on tracked buffers and a...
fb1f0dfec9 ERC: Track: Fix documentation of structure of 'erc-modifie...
252a769b11 ; * doc/lispref/files.texi (Changing Files): Fix xref to f...
edc93a5ce6 ; Fix grammar in efaq.texi on Emacs vs XEmacs.

# Conflicts:
#	doc/misc/efaq.texi
2021-09-11 23:03:57 -04:00
Eli Zaretskii
aa6cacd713 Document tool-bar and tab-bar mouse events
* doc/lispref/commands.texi (Click Events): Document the format of
POSITION for tab-bar and tool-bar events.
2021-09-11 14:40:51 +03:00
Stephen Gildea
252a769b11 ; * doc/lispref/files.texi (Changing Files): Fix xref to file-modes.
'file-modes' is in node "Testing Accessibility", not "File Attributes".
2021-09-10 20:22:47 -07:00
Eli Zaretskii
0daad76704 Improve documentation of line truncation and wrapping
* doc/emacs/display.texi (Line Truncation, Visual Line Mode):
* doc/lispref/display.texi (Truncation): Document that turning on
line truncation disables wrapping, and vice versa.

* src/buffer.c (syms_of_buffer) <truncate-lines>:
* src/xdisp.c (syms_of_xdisp) <truncate-partial-width-windows>:
Warn against turning on when 'visual-line-mode' is in effect.
* lisp/simple.el (visual-line-mode): Document that this mode
disables line truncation.  (Bug#29664)
2021-09-04 13:34:32 +03:00
Lars Ingebrigtsen
3f999c03c2 Add support for customization group hyperlinks in doc strings
* lisp/help-mode.el (help-customization-group): New button.
(help-xref-customization-group-regexp): New const.
(help-make-xrefs): Use them to allow making customization group
buttons.
2021-09-04 10:19:03 +02:00
Stefan Kangas
0cabf8bc36 ; Fix typos 2021-09-03 13:05:32 +02:00
Lars Ingebrigtsen
6a6de68daf Add new macro `with-existing-directory'
* doc/lispref/files.texi (Testing Accessibility): Document it.
* lisp/subr.el (with-existing-directory): New macro (bug#32004).
2021-09-01 15:56:04 +02:00
Eli Zaretskii
f1901fc308 Better document obsolescence of 'values'
* doc/lispref/eval.texi (Eval): Mention that 'values' is obsolete.
* etc/NEWS: Add a rationale for obsoleting 'values'.
2021-08-29 14:47:02 +03:00
Eli Zaretskii
a849b56410 Document 'jit-lock-bounds'
* doc/lispref/modes.texi (Other Font Lock Variables):
* lisp/jit-lock.el (jit-lock-functions, jit-lock-register):
Document the return value of the fontification functions.
2021-08-23 23:14:00 +03:00
Mattias Engdegård
4281e5b34d Add example of advanced user-defined Rx form to manual
* doc/lispref/searching.texi (Extending Rx): Add example illustrating
how to define a user-defined Rx form that performs computation,
from a discussion with Michael Herdeegen (bug#50136).
* lisp/emacs-lisp/rx.el (rx): Clarify evaluation time for `eval`.
2021-08-23 19:57:17 +02:00
Eli Zaretskii
efddcc9fbe Improve recently-changed docs
* src/frame.c (Fnext_frame):
* doc/lispref/frames.texi (Finding All Frames): Improve wording
and style of the 'next-frame's documentation.
2021-08-23 19:11:49 +03:00
Lars Ingebrigtsen
4167d4b4b2 Clarify the documentation of `next-frame'
* doc/lispref/frames.texi (Finding All Frames): Clarify what it
means to "consider".
* src/frame.c (Fnext_frame): Rewrite doc string to say what the
parameters actually mean (bug#13339).
2021-08-23 16:32:33 +02:00
Eli Zaretskii
6430c8419c ; * doc/lispref/variables.texi (Local Variables): Fix indexing. 2021-08-23 14:50:24 +03:00
Lars Ingebrigtsen
cc2c150636 Document `dlet'
* doc/lispref/variables.texi (Local Variables): Document `dlet'.
2021-08-23 02:13:40 +02:00
Eli Zaretskii
316cc9152f Improve documentation of 'set-keyboard-coding-system'
* doc/lispref/nonascii.texi (Terminal I/O Encoding):
* doc/emacs/mule.texi (Terminal Coding):
* lisp/international/mule.el (set-keyboard-coding-system):
Document that 'set-keyboard-coding-system' has no effect on modern
MS-Windows systems.  (Bug#15289)
2021-08-22 11:32:26 +03:00
Eli Zaretskii
72e688eacd Improve documentation of context menus
* doc/lispref/modes.texi (Major Mode Conventions): Add conventions
of setting menu-bar menus and context menus for a major mode.
* doc/emacs/frames.texi (Menu Mouse Clicks): Fix description of
context menu functionality.
2021-08-21 11:49:56 +03:00
Eli Zaretskii
beb54dc1b2 Improve documentation of 'file-preserve-symlinks-on-save'
* lisp/files.el (file-precious-flag): Mention
'file-preserve-symlinks-on-save' in the doc string.

* doc/lispref/files.texi (Saving Buffers): Move the description of
'file-preserve-symlinks-on-save' from here...
* doc/emacs/files.texi (Customize Save): ...to here.  Improve
wording.

* etc/NEWS: Fix wording of 'file-preserve-symlinks-on-save' entry.
2021-08-21 10:58:24 +03:00
Lars Ingebrigtsen
13fdded2c1 Allow preserving symlinks with file-precious-flag set
* doc/lispref/files.texi (Saving Buffers): Document it.
* lisp/files.el (file-preserve-symlinks-on-save): New user option
(bug#18125).
(basic-save-buffer-2): Use it.
2021-08-20 16:20:51 +02:00
Eli Zaretskii
1511f3cecc Fix inaccuracies in documentation of 'message-truncate-lines'
* doc/lispref/display.texi (Echo Area Customization):
* src/xdisp.c (syms_of_xdisp): Adjust the documentation of
message-truncate-lines to changes that fixed bug#46718.
2021-08-19 15:44:55 +03:00
Eli Zaretskii
78b427648b Improve documentation of 'assoc'
* doc/lispref/lists.texi (Association Lists):
* src/fns.c (Fassoc): Document how TESTFN is called.  (Bug#50110)
2021-08-18 22:07:30 +03:00
Stephen Berman
ae751f2a09 ; Fix menu entry alignment of last change
* doc/lispref/elisp.texi (Top): Fix alignment.
2021-08-16 22:55:50 +02:00
Stephen Berman
b21c9b0816 Add Command Modes to Elisp manual menu and add index entries
* doc/lispref/commands.texi (Command Modes): Add index entries.

* doc/lispref/elisp.texi (Top): Add entry for the Command Modes
node to the detailed node listing.
2021-08-16 19:13:53 +02:00
Eli Zaretskii
f0ef1e971d Fix recent documentation additions
* doc/lispref/searching.texi (Search and Replace): Document the
new functions by @defun.
2021-08-16 20:11:33 +03:00
Lars Ingebrigtsen
5d7b1d5fc7 Make overlays-in treat zero-length overlays at point-max consistently
* doc/lispref/display.texi (Finding Overlays): Adjust documentation.

* src/buffer.c (overlays_in): Treat the end of the buffer and the
end of the narrowed-to buffer the same (bug#19422).
(Foverlays_in): Adjust doc string.
2021-08-16 15:40:43 +02:00
Lars Ingebrigtsen
b9243b034b Minor clarification for define-minor-mode :variable
* lisp/emacs-lisp/easy-mmode.el (define-minor-mode):
* doc/lispref/modes.texi (Defining Minor Modes): Clarify what the
setter function should do (bug#14875).
2021-08-16 14:24:53 +02:00
Lars Ingebrigtsen
751f1707f0 Add new functions to replace strings/regexp in a region
* doc/lispref/searching.texi (Search and Replace): Document them.
* lisp/subr.el (replace-string-in-region)
(replace-regexp-in-region): New functions.

* lisp/emacs-lisp/shortdoc.el (regexp, buffer): Mention them.
2021-08-16 13:20:35 +02:00
Lars Ingebrigtsen
3fd0cc85a5 Revert "Add macro seq-setq."
This reverts commit a8a3fd8f8e.

The same patch was applied twice.  Remove the second instance.
2021-08-14 15:30:17 +02:00
Earl Hyatt
a8a3fd8f8e Add macro seq-setq.
* doc/lispref/sequences.texi (seq-setq): Document this macro.

* test/lisp/emacs-lisp/seq-tests.el (test-seq-setq):
Test this macro (bug#50053).
2021-08-14 14:17:55 +02:00
Earl Hyatt
c58f8dda2b Add macro seq-setq.
* doc/lispref/sequences.texi (seq-setq): Document this macro.

* lisp/emacs-lisp/seq.el (seq-setq): New macro.

* test/lisp/emacs-lisp/seq-tests.el (test-seq-setq):
Test this macro (bug#50053).
2021-08-14 14:17:12 +02:00
Mattias Engdegård
1bfbb2b706 Add font-lock-doc-markup-face (bug#50041)
This face is intended for mark-up syntax and constructs inside text
using font-lock-doc-face; ie, documentation comments and strings in
programming modes.

* lisp/font-lock.el (font-lock-doc-markup-face): New face.
* lisp/cus-theme.el (custom-theme--listed-faces): Add it to the list.
* doc/lispref/modes.texi (Faces for Font Lock): Document it.
* etc/NEWS: Mention it.
2021-08-14 11:00:40 +02:00
Earl Hyatt
2f90fa19b8 Add a `pcase-setq' macro
* doc/lispref/control.texi (Destructuring with pcase Patterns):
Document this macro.

* lisp/emacs-lisp/pcase.el (pcase-setq): New macro.  This macro is
the 'setq' equivalent of 'pcase-let'.

* test/lisp/emacs-lisp/pcase-tests.el (pcase-setq): Test this new
macro. (bug#49809).
2021-08-11 23:54:31 +02:00
Eli Zaretskii
b17fd982a3 ; * doc/lispref/package.texi (Package Archives): Fix typo. 2021-08-06 14:20:54 +03:00
Lars Ingebrigtsen
483fce3093 Mention NonGNU in "Package Archives" node in the manual
* doc/lispref/package.texi (Package Archives): Mention NonGNU, too
(bug#49899).
2021-08-06 13:03:28 +02:00
Lars Ingebrigtsen
b8c43b594e Add a new thing-at-point type: existing-filename
* doc/lispref/text.texi (Buffer Contents): Mention it.

* lisp/thingatpt.el (thing-at-point-file-at-point): New function.
(existing-filename): Register it.
2021-08-04 10:35:53 +02:00