1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-04 14:40:54 -08:00
Commit graph

3627 commits

Author SHA1 Message Date
Stefan Kangas
8b87ea6844 Recommend lexical-binding in Coding Conventions
* doc/lispref/tips.texi (Coding Conventions, Library Headers):
Recommend using lexical-binding.
2020-10-22 20:28:59 +02:00
Eli Zaretskii
72dd911981 Fix posn-at-x-y in builds --without-x
* src/keyboard.c (make_lispy_position): Don't exclude the
window_or_frame = frame case from TTY-only builds.  Reported by
Jared Finder <jared@finder.org>.

* doc/lispref/commands.texi (Click Events): Document the format of
POSITION in click events on the frame's internal border.
2020-10-16 10:02:50 +03:00
Lars Ingebrigtsen
ace25f2066 Clarify the seq-reduce documentation
* doc/lispref/sequences.texi (Sequence Functions): Ditto.

* lisp/emacs-lisp/seq.el (seq-reduce): Clarify the order of the
arguments (bug#43995).
2020-10-15 09:37:44 +02:00
Stefan Kangas
bf4accb65e ; Fix some trivial typos 2020-09-21 15:04:55 +02:00
Eli Zaretskii
02a31c9632 Minor improvement in the ELisp manual's Introduction
* doc/lispref/intro.texi (Printing Notation): Clarify what
"execute code" means in this context.  (Bug#43463)
2020-09-20 17:33:55 +03:00
Eli Zaretskii
082d8a21b1 Minor copyedits in 'line-height' documentation
* doc/lispref/display.texi (Line Height): Describe the possible
values of the 'line-height' property in a more consistent format.
2020-09-19 22:22:08 +03:00
Eli Zaretskii
df04f3e755 Fix a rare segfault in syntax.c
* src/syntax.c (Fforward_comment): Prevent the loop for COUNT < 0
from going outside the valid range of character/byte positions.
(Bug#43499)

* doc/lispref/syntax.texi (Syntax Class Table): Mention the
"comment-fence" and "string-fence" as alternative names of 2
syntax classes.
2020-09-19 19:54:01 +03:00
Alan Mackenzie
fd1fe1e1ec Add doc to syntax-propertize-function saying it must do a 100% job
and cannot be combined with other ways of applying syntax-table text
properties.

* lisp/emacs-lisp/syntax.el (syntax-propertize-function): Amend doc string.

* doc/lispref/syntax.texi (Syntax Properties): Amend the description of the
variable.
2020-09-19 16:50:27 +00:00
Eli Zaretskii
fcd599bbea Minor copyedits of doc of 'with-silent-modifications'
* doc/lispref/text.texi (Changing Properties):
* doc/lispref/buffers.texi (Buffer Modification): Improve
documentation and indexing of 'with-silent-modifications'.
2020-09-19 11:30:57 +03:00
Eli Zaretskii
759399cdb1 Improve documentation of 'max-mini-window-height'
* src/xdisp.c (syms_of_xdisp):
* doc/lispref/minibuf.texi (Minibuffer Windows): More accurate
wording in the documentation of 'max-mini-window-height', to
clarify the meaning of an integer value.
2020-09-18 22:50:36 +03:00
Stefan Kangas
abca75d2e9 ; Fix typos; change "Emacs-Lisp" to "Emacs Lisp" 2020-09-02 00:01:37 +02:00
Stefan Kangas
7605060d51 Update Elisp Manual reference to which-function-mode
* doc/lispref/modes.texi (Mode Line Top, Mode Line Variables)
Don't refer to obsolete alias for 'which-function-mode'.
(Bug#13716)
2020-08-31 04:39:09 +02:00
Eli Zaretskii
4a73fb9668 Fix description of %-constructs in 'mode-line-format'
* doc/lispref/modes.texi (%-Constructs): Document %@ and remove
%M, which is no longer supported.   (Bug#43092)
2020-08-29 09:45:51 +03:00
Eli Zaretskii
9b403d624e ; Fix last change 2020-08-15 18:19:01 +03:00
Eli Zaretskii
6bff65a626 ; * doc/lispref/sequences.texi (Sequence Functions): Typo Fix. (Bug#42871) 2020-08-15 18:16:39 +03:00
Mattias Engdegård
8ff5e346fe Regexps cannot infloop; fix manual
* doc/lispref/searching.texi (Regexp Special): Edit erroneous
statements about infinite looping in regexps.

(cherry picked from commit 63268253d2)
2020-08-14 14:52:13 +02:00
Eli Zaretskii
69568674b3 Improve documentation of function argument lists
* doc/lispref/functions.texi (Lambda Components)
(Defining Functions): Add a cross-reference to "Argument List".
(Argument List): Improve the section name.  (Bug#42750)
2020-08-13 17:08:37 +03:00
Eli Zaretskii
1c0bc1ccd8 Improve documentation of special events
* doc/lispref/commands.texi (Misc Events): Explain how to bind
special events to commands.
2020-08-13 16:53:14 +03:00
Stefan Kangas
d024fc141b * doc/lispref/symbols.texi (Definitions): Fix typo. 2020-07-29 12:35:19 +02:00
Eli Zaretskii
0d4ba1c2b2 Improve documentation of 'kill-emacs'
* doc/lispref/os.texi (Killing Emacs):
* src/emacs.c (Fkill_emacs): Document what non-integer, non-string
argument to 'kill-emacs' means.  (Bug#42400)
2020-07-17 17:54:00 +03:00
Mattias Engdegård
bdf716bba1 Correct 'concat' manual entry (bug#42296)
* doc/lispref/strings.texi (Creating Strings): 'concat' does not
necessarily return a newly allocated string.  This has been the case
at least since 1997 (Emacs 20.3).
2020-07-11 15:15:24 +02:00
Paul Eggert
1f52771fd3 Mention floating rounding issues
* doc/lispref/numbers.texi (Float Basics): Mention floating-point
rounding issues uncovered by the discussion in Bug#42417.
2020-07-09 08:40:58 -07:00
Eli Zaretskii
79f381b4a6 One more improvement of left/right-fringe display spec docs
* doc/lispref/display.texi (Fringe Bitmaps): Yet another
clarification of how to use FACE in left/right-fringe display
spec.
2020-07-08 17:39:13 +03:00
Eli Zaretskii
1279bdb072 Another clarification of left/right-fringe display spec
* doc/lispref/display.texi (Fringe Bitmaps): More accurate
description of what FACE means in the left/right-fringe display
spec.
2020-07-07 17:55:24 +03:00
Eli Zaretskii
247dcb4b1b Clarify the documentation of 'left/right-fringe' display spec
* doc/lispref/display.texi (Other Display Specs, Fringe Bitmaps):
Clarify how the optional FACE parameter of the left-fringe and
right-fringe display spec is used.  Reported by Gregory Heytings
<ghe@sdf.org>.
2020-07-05 18:30:21 +03:00
Eli Zaretskii
d453cee177 Minor improvement in ELisp manual
* doc/lispref/frames.texi (Position Parameters): Clarify the
description of the 'above' frame parameter.  (Bug#42154)
2020-07-04 10:19:56 +03:00
Eli Zaretskii
4c81724675 Don't use 'cl' functions in ELisp manual's examples
* doc/lispref/control.texi (pcase Macro): Use 'cl-evenp' instead
of 'evenp'.  (Bug#41947)
2020-06-20 10:29:37 +03:00
Basil L. Contovounesios
229995ba2c Fix some Texinfo markup
* doc/misc/gnus-faq.texi (FAQ 3-11):
* doc/emacs/frames.texi (Tab Bars): Consistently use @var with
lower-case metasyntactic variables and @minus instead of a dash.
(Text-Only Mouse):
* doc/emacs/files.texi (Auto Revert):
* doc/emacs/misc.texi (emacsclient Options)
(Embedded WebKit Widgets):
* doc/lispref/control.texi (pcase Macro):
* doc/lispref/debugging.texi (Backtraces):
* doc/lispref/files.texi (Truenames):
* doc/lispref/frames.texi (Management Parameters):
* doc/lispref/os.texi (Time Calculations):
* doc/lispref/text.texi (Parsing JSON):
* doc/misc/efaq-w32.texi (Other versions of Emacs, Debugging)
(Swap Caps NT, Printing, Bash, Developing with Emacs):
* doc/misc/efaq.texi (New in Emacs 25):
* doc/misc/emacs-gnutls.texi (Help For Users):
* doc/misc/message.texi (Using S/MIME, Passphrase caching):
* test/manual/etags/tex-src/gzip.texi (Overview): Use @. when a
sentence in the middle of a paragraph ends with an upper-case letter
as per "(texinfo) Ending a Sentence".
2020-06-17 13:07:51 +01:00
Basil L. Contovounesios
6cdecc2659 Revert markup change in with-coding-priority docs
This partially reverts commit fc759eb9b3
"Fix with-coding-priority markup in Elisp manual"
of 2019-10-13T15:36:02Z!contovob@tcd.ie.

For discussion, see the following thread:
https://lists.gnu.org/archive/html/emacs-devel/2019-10/msg00550.html
https://lists.gnu.org/archive/html/emacs-devel/2020-06/msg00473.html

* doc/lispref/nonascii.texi (Specifying Coding Systems): Use more
specific cross-reference to progn even if info.el displays it
suboptimally.
2020-06-13 17:54:51 +01:00
Basil L. Contovounesios
43ad7dc1af Clean up D-Bus documentation (bug#41744)
* doc/lispref/errors.texi (Standard Errors): The error symbol
dbus-error is defined even when Emacs is built without D-Bus.

* doc/misc/dbus.texi (Bus Names, Introspection)
(Nodes and Interfaces, Methods and Signal)
(Properties and Annotations, Arguments and Signatures)
(Synchronous Methods, Receiving Method Calls, Signals)
(Alternative Buses, Errors and Events): Clarify wording.  Fix
indentation of and simplify examples where possible.  Improve
Texinfo markup and cross-referencing where possible.
(Type Conversion): Ditto.  Remove mentions of Emacs' fixnum range
now that we have bignums.

* lisp/net/dbus.el (dbus-return-values-table)
(dbus-call-method-asynchronously, dbus-send-signal)
(dbus-register-signal, dbus-register-method)
(dbus-string-to-byte-array, dbus-byte-array-to-string)
(dbus-escape-as-identifier, dbus-check-event, dbus-event-bus-name)
(dbus-event-message-type, dbus-event-serial-number)
(dbus-event-service-name, dbus-event-path-name)
(dbus-event-interface-name, dbus-event-member-name)
(dbus-list-activatable-names, dbus-list-queued-owners, dbus-ping)
(dbus-introspect-get-interface-names, dbus-introspect-get-interface)
(dbus-introspect-get-method, dbus-introspect-get-signal)
(dbus-introspect-get-property, dbus-introspect-get-annotation-names)
(dbus-introspect-get-annotation, dbus-introspect-get-argument-names)
(dbus-introspect-get-argument, dbus-introspect-get-signature)
(dbus-set-property, dbus-register-property)
(dbus-get-all-managed-objects, dbus-init-bus): Clarify docstring and
improve formatting where possible.
(dbus-call-method): Ditto.  Remove mentions of Emacs' fixnum range
now that we have bignums.
2020-06-08 18:19:50 +01:00
Basil L. Contovounesios
35661ef943 Fix typo in "(elisp) Type Keywords"
* doc/lispref/customize.texi (Type Keywords): Fix typo of 'choice'
composite type.  (Bug#41749)
2020-06-07 16:46:12 +01:00
Eli Zaretskii
dd366b5d3b Improve documentation of 'window-text-pixel-size'
* doc/lispref/display.texi (Size of Displayed Text): Clarify the
description of 'window-text-pixel-size'.
2020-06-06 20:10:37 +03:00
Eli Zaretskii
bf09106256 Improve documentation of 'sort-subr'
* doc/lispref/text.texi (Sorting): Clarify the meaning and use of
PREDICATE argument to 'sort-subr'.  (Bug#41706)
2020-06-05 11:30:03 +03:00
Basil L. Contovounesios
b07e3b1d97 Improve format-spec documentation (bug#41571)
* doc/lispref/text.texi (Interpolated Strings): Move from here...
* doc/lispref/strings.texi (Custom Format Strings): ...to here,
renaming the node and clarifying the documentation.
(Formatting Strings): End node with sentence referring to the next
one.
* lisp/format-spec.el (format-spec): Clarify docstring.
2020-06-02 14:58:25 +01:00
Glenn Morris
bd7b681dc4 Tiny texinfo markup fixes
* doc/lispref/edebug.texi (Edebug Views):
* doc/lispref/loading.texi (Library Search):
* doc/lispref/os.texi (User Identification): Markup fixes.
2020-05-27 16:30:00 -07:00
Basil L. Contovounesios
d0dd0e0612 ; Fix more @var/@code mixups in Elisp manual
* doc/lispref/text.texi (Replacing): Fix markup for function
arguments.
2020-05-28 00:12:54 +01:00
Basil L. Contovounesios
313dc0439e ; Fix another format-spec typo in the Elisp manual
* doc/lispref/text.texi (Interpolated Strings): Correct markup for
function argument.
2020-05-27 23:43:14 +01:00
Basil L. Contovounesios
4737d0af75 Fix Elisp manual entry for format-spec
* doc/lispref/text.texi (Interpolated Strings): Fix typos.  Don't
document modifier for default space padding as it's redundant and
inconsistent with the docstring and implementation of format-spec.
2020-05-24 22:17:53 +01:00
Eli Zaretskii
1a6d59eeba Improve the documentation of setting up fontsets
* doc/lispref/display.texi (Fontsets): Improve the accuracy of a
cross-reference to "Character Properties".

* doc/emacs/mule.texi (Fontsets, Modifying Fontsets): Improve the
documentation of fontsets and how to modify them.
2020-05-23 15:14:27 +03:00
Stefan Kangas
8cc453d788 Second attempt at improving indexing in control.texi
* doc/lispref/control.texi (Processing of Errors): Improve indexing by
adding the word form "handle" in addition to "handling".  With thanks
to Eli Zaretskii.
2020-05-21 04:57:10 +02:00
Stefan Kangas
03d44acfdd * doc/lispref/control.texi (Processing of Errors): Improve indexing. 2020-05-19 02:36:07 +02:00
Paul Eggert
b48ab743a8 Minor fixups for mutability doc
* doc/lispref/objects.texi (Mutability): Minor fixups in
response to a comment by Dmitry Gutov (Bug#40671#477).
2020-05-16 18:24:08 -07:00
Paul Eggert
6ac2326e5b Don’t use “constant” for values you shouldn’t change
Inspired by patch proposed by Dmitry Gutov (Bug#40671#393)
and by further comments by him and by Michael Heerdegen
in the same bug report.
* doc/lispintro/emacs-lisp-intro.texi (setcar):
Don’t push mutability here.
* doc/lispref/eval.texi (Self-Evaluating Forms, Quoting)
(Backquote):
* doc/lispref/lists.texi (Modifying Lists):
* doc/lispref/objects.texi (Lisp Data Types, Mutability):
* doc/lispref/sequences.texi (Array Functions, Vectors):
* doc/lispref/strings.texi (String Basics, Modifying Strings):
Don’t use the word “constant” to describe all values that
a program should not change.
* doc/lispref/objects.texi (Mutability):
Rename from “Constants and Mutability”.  All uses changed.
In a footnote, contrast the Emacs behavior with that of Common
Lisp, Python, etc. for clarity, and say the goal is to be nicer.
2020-05-16 18:24:07 -07:00
Philipp Stephani
406fb0746c Fix documentation related to 'command-switch-alist'.
While there, add a unit test to verify the behavior.

* doc/lispref/os.texi (Command-Line Arguments): Fix documentation: the
option string in 'command-switch-alist' does include leading hyphens.
Also mention that 'command-switch-alist' parsing ignores equals signs
in options.

* test/lisp/startup-tests.el
(startup-tests/command-switch-alist): New unit test.
2020-05-14 19:29:14 +02:00
Paul Eggert
0a3731feef Make memq etc. examples more like they were
Problem reported by Štěpán Němec in:
https://lists.gnu.org/r/emacs-devel/2020-05/msg00130.html
* doc/lispref/lists.texi (Sets And Lists, Association Lists):
Revert examples to be more like the way they were, using
self-evaluating expressions.  Be more consistent about listing
unspecified results.
2020-05-02 13:49:32 -07:00
Stefan Kangas
1d477a0fec Recommend to avoid unnecessary abbreviations in doc
* doc/lispref/tips.texi (Documentation Tips): Recommend to avoid
unnecessary abbreviations.  (Bug#40011)
2020-04-30 18:02:28 +02:00
Paul Eggert
68f4a740a1 Remove doc duplication
* doc/lispref/objects.texi (Constants and Mutability): Remove
duplication.  From a suggestion by Andreas Schwab (Bug#40671#150).
2020-04-25 11:22:32 -07:00
Clément Pit-Claudel
3d0e859692 Minor doc clarification regarding fringe bitmaps
* doc/lispref/display.texi (Customizing Bitmaps): Add a note
regarding the order of bits being the opposite of that in
XBM images.  (Bug#40784)
2020-04-25 12:57:21 +03:00
Eli Zaretskii
4d86c7f822 Fix documentation of fringe bitmaps
* doc/lispref/display.texi (Fringe Bitmaps): The 'empty-line'
fringe indicator _is_ used.  (Bug#40799)
2020-04-25 12:48:14 +03:00
Paul Eggert
a76af88dd8 Tweak mutability doc a bit more
Inspired by a comment from Michael Heerdegen (Bug#40671#114).
* doc/lispref/objects.texi (Constants and Mutability): Tweak further.
2020-04-24 19:20:38 -07:00