1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-05-03 11:41:41 -07:00
Commit graph

3608 commits

Author SHA1 Message Date
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
Stefan Kangas
a92ca1f177 Improve indexing of ELisp manual
* doc/lispref/tips.texi (Tips): Add index entry 'best practices'.
2020-04-24 08:07:02 +02:00
Paul Eggert
400ff5cd19 Improve wording about constants
Thanks to Štěpán Němec and Drew Adams for reviews of recent changes.
* doc/lispref/eval.texi (Quoting): Give an example.
* doc/lispref/lists.texi (Association Lists): Simplify example code.
* doc/lispref/objects.texi (Lisp Data Types)
(Constants and Mutability): Clarify wording.
2020-04-22 10:43:46 -07:00
Paul Eggert
05089a4d65 Tweak wording re constant variables
* doc/lispref/objects.texi (Constants and Mutability): Tweak.
Problem reported by Michael Heerdegen (Bug#40693#44).
2020-04-19 19:53:40 -07:00
Paul Eggert
a1040861f1 Tweak setcar-related wording
* doc/lispref/eval.texi (Self-Evaluating Forms):
Change “primitives” to “operations”.
Problem reported by Štěpán Němec in:
https://lists.gnu.org/r/emacs-devel/2020-04/msg01146.html
2020-04-19 16:47:17 -07:00
Paul Eggert
e1d42da0d6 Fix mutability glitches reported by Drew Adams
See Bug#40693#32.
* doc/lispref/eval.texi (Self-Evaluating Forms, Backquote):
Say that these yield constant conses, vectors and strings,
not constant symbols.
* doc/lispref/objects.texi (Constants and Mutability): Say that an
attempt to modify a constant variable signals an error, instead of
saying that it has undefined behavior.
2020-04-19 15:12:05 -07:00
Paul Eggert
5805df74f5 Improve mutability doc
See Eli Zaretskii’s suggestions (Bug#40671#33).
* doc/lispref/lists.texi (Setcar, Setcdr, Rearrangement):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions):
Add commentary to examples.
* doc/lispref/lists.texi (Sets And Lists):
Revert change to delq example.
2020-04-19 13:29:57 -07:00
Paul Eggert
dca35b31d0 Improve mutability documentation
This change was inspired by comments from Štěpán Němec in:
https://lists.gnu.org/r/emacs-devel/2020-04/msg01063.html
* doc/lispref/objects.texi (Lisp Data Types): Mention mutability.
(Constants and mutability): New section.
* doc/lispintro/emacs-lisp-intro.texi (Lists diagrammed)
(Indent Tabs Mode): Improve wording.
* doc/lispref/eval.texi (Self-Evaluating Forms):
Say that they return constants.
* doc/lispref/lists.texi (Sets And Lists):
Fix memql mistake/confusion that I recently introduced.
2020-04-19 13:29:57 -07:00
Paul Eggert
81e7d7f111 Document that quoting yields constants
* doc/lispref/eval.texi (Quoting, Backquote):
Mention that quoted expressions yield a constant (Bug#40693).
2020-04-19 13:29:57 -07:00
Stefan Monnier
5734339f40 * doc/lispref/keymaps.texi (Extended Menu Items, Easy Menu) <:key-sequence>:
Clarify the documentation further
2020-04-19 11:19:03 -04:00
Mattias Engdegård
14a570afae Remove #' and function quoting from lambda forms in manual
* doc/lispref/abbrevs.texi (Abbrev Expansion):
* doc/lispref/backups.texi (Reverting):
* doc/lispref/functions.texi (Mapping Functions):
* doc/lispref/help.texi (Accessing Documentation):
* doc/lispref/sequences.texi (Char-Tables):
* doc/lispref/syntax.texi (Categories):
* doc/lispref/text.texi (Sorting):
Remove function quoting from lambda in examples where it still occurs,
since examples should follow our best style and be consistent.
2020-04-19 13:19:37 +02:00
Paul Eggert
5e9db48fbe * doc/lispref/display.texi (Customizing Bitmaps): Fix typo. 2020-04-18 13:01:08 -07:00
Paul Eggert
eebfb72c90 Document constant vs mutable objects better
This patch builds on a suggested patch by Mattias Engdegård
and on further comments by Eli Zaretskii.
Original bug report by Kevin Vigouroux (Bug#40671).
* doc/lispintro/emacs-lisp-intro.texi (set & setq, Review)
(setcar, Lists diagrammed, Mail Aliases, Indent Tabs Mode):
setq is a special form, not a function or command.
* doc/lispintro/emacs-lisp-intro.texi (setcar):
* doc/lispref/lists.texi (Modifying Lists, Rearrangement):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions, Vectors):
* doc/lispref/strings.texi (String Basics, Modifying Strings):
Mention mutable vs constant objects.
* doc/lispintro/emacs-lisp-intro.texi (setcar, setcdr)
(kill-new function, cons & search-fwd Review):
* doc/lispref/edebug.texi (Printing in Edebug):
* doc/lispref/keymaps.texi (Changing Key Bindings):
* doc/lispref/lists.texi (Setcar, Setcdr, Rearrangement)
(Sets And Lists, Association Lists, Plist Access):
* doc/lispref/sequences.texi (Sequence Functions)
(Array Functions):
* doc/lispref/strings.texi (Text Comparison):
Fix examples so that they do not try to change constants.
2020-04-18 13:01:08 -07:00
Štěpán Němec
067b070598 ; Fix some typos and doc issues (bug#40695) 2020-04-18 17:10:02 +02:00
Martin Rudalics
e5ca8e5e73 Fix Elisp manual entry on 'set-window-configuration'
* doc/lispref/windows.texi (Window Configurations): Fix
description of 'set-window-configuration'.
2020-04-15 10:18:15 +02:00
Štěpán Němec
f84aed5fd2 Clarify documentation on inhibit-modification-hooks intended usage
Cf. bug#40332 and the discussion at
https://lists.gnu.org/archive/html/emacs-devel/2020-03/msg00921.html

* doc/lispref/text.texi (Change Hooks):
* src/insdel.c (syms_of_insdel): Clarify the intended usage of
'inhibit-modification-hooks'.
2020-04-13 12:15:13 +02:00
Eli Zaretskii
fd27685c1e ; * doc/lispref/keymaps.texi (Extended Menu Items): Fix last change. 2020-04-11 09:40:37 +03:00
Stefan Monnier
6057d79a4e * doc/lispref/keymaps.texi (Extended Menu Items): Tweak :key-sequence
Don't make it sound like `:key-sequence nil` is any different than the
absence of `:key-sequence`.  And the performance advantage of
`:key-sequence` disappeared long ago.
2020-04-10 17:04:19 -04:00
Eli Zaretskii
18d1bc0a09 Improve documentation of 'jit-lock-contextually'
* lisp/jit-lock.el (jit-lock-contextually): Clarify the jit-lock
operation when 'jit-lock-contextually' is non-nil and non-t.

* doc/lispref/modes.texi (Syntactic Font Lock)
(Other Font Lock Variables): Document the relation between
'jit-lock-register', 'font-lock-keywords-only', and syntactic
refontification.
2020-04-08 18:33:52 +03:00
Mattias Engdegård
0883c800a0 Simplify rx example in manual
* doc/lispref/searching.texi (Rx Notation):
Use the 'not' shorthand introduced in Emacs 27.
2020-03-09 16:00:18 +01:00