1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-04-27 16:51:06 -07:00
Commit graph

7923 commits

Author SHA1 Message Date
Basil L. Contovounesios
01e86b9fdf Fix recentf typo in Emacs manual
* doc/emacs/files.texi (File Conveniences): Fix misspelling of
recentf-list.
2020-06-17 01:10:20 +01:00
Michael Albinus
a71d1787f1 * doc/misc/tramp.texi (Predefined connection information): Add "tmpdir". 2020-06-16 12:34:00 +02: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
Basil L. Contovounesios
d8593fd19f Minor improvements to EDE and EIEIO manuals
For discussion, see the following threads:
https://lists.gnu.org/archive/html/emacs-devel/2020-05/msg00630.html
https://lists.gnu.org/archive/html/emacs-devel/2020-06/msg00099.html

* doc/misc/ede.texi (ede-generic-project): Clean up example.
* doc/misc/eieio.texi (Accessing Slots): Document slot-value as a
generalized variable and set-slot-value as obsolete.
(Predicates): Fix typo.
(Introspection): Document eieio-class-slots in place of the obsolete
object-slots.
2020-06-06 16:35:52 +01: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
João Távora
44c0e074f7 * doc/emacs/buffers.texi (Icomplete): Mention icomplete-minibuffer-setup-hook. 2020-06-01 01:29:50 +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
Eli Zaretskii
13b6dfd4f7 * doc/emacs/killing.texi (Rectangles): Improve indexing. 2020-05-23 10:33:35 +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
Eli Zaretskii
b4937f64cd Improve documentation of manually installing Lisp packages
* doc/emacs/building.texi (Lisp Libraries): Describe how to
manually load packages in the init file.  Mention the 'site-lisp'
subdirectory of the default 'load-path'.

* doc/emacs/package.texi (Packages): Describe manual installation
of ELisp packages.  Suggested by Jean-Christophe Helary
<jean.christophe.helary@traduction-libre.org>.
2020-05-16 11:54:37 +03:00
Eli Zaretskii
efd4e973a4 Reflect the emacs-devel ELPA/MELPA dispute in FAQ
* doc/misc/efaq.texi (Packages that do not come with Emacs): Warn
that some MELPA packages may require non-free software.
2020-05-16 10:30:43 +03: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
632aa9d57a Go back to “Bahá’í”
* doc/emacs/calendar.texi (Holidays): Revert previous change, as
bahai.org spells it “Bahá’í” (with U+2019 RIGHT SINGLE QUOTATION
MARK) and that’s good enough for us.
2020-05-10 09:14:17 -07:00
Eli Zaretskii
7081c1d66f Fix typos in the Emacs user manual
* doc/emacs/calendar.texi (Holidays): Fix usage of non-ASCII
accents.
* doc/emacs/custom.texi (Init Rebinding): Fix a cross-reference.
* doc/emacs/dired.texi (Operating on Files): Make the
cross-reference to "VC Delete/Rename" be to a different manual in
the printed version.  (Bug#41100)
2020-05-08 14:21:35 +03:00
Eli Zaretskii
76516465bf * doc/emacs/modes.texi (Major Modes): Fix quoting. (Bug#41110) 2020-05-06 17:13:55 +03:00
Eli Zaretskii
7be160d800 Improve "Help Summary" section in user manual
* doc/emacs/help.texi (Help Summary): Add cross-references to
sections with details of each Help command.
2020-05-05 17:47:33 +03: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
Eli Zaretskii
ed25282b82 Document effect of 'search-upper-case' on replacement commands
* doc/emacs/search.texi (Replacement and Lax Matches): Document
the role of 'search-upper-case' in replacement commands.
(Lax Search): Document the value 'not-yanks' of
'search-upper-case' where the variable itself is documented.

* lisp/replace.el (query-replace-regexp, query-replace): Mention
'search-upper-case' and its effect in doc strings.  (Bug#40940)
2020-05-02 10:54:01 +03: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
Stefan Kangas
0278741676 Fix typo in custom.texi
* doc/emacs/custom.texi (Variables): Fix typo.  Pointed out by
ej32u@protonmail.com.  (Bug#40890)
2020-04-27 17:09:11 +02:00
Juri Linkov
f0e1bf56f0 Fix bugs in tab-bar and tab-line and mention remaining features in manual.
* doc/emacs/frames.texi (Tab Bars): Mention tab-bar-new-tab-to,
tab-bar-close-last-tab-choice, tab-bar-close-tab-select, tab-undo,
tab-select, tab-bar-history-mode.

* doc/emacs/windows.texi (Tab Line): Mention tab-line-tabs-function.

* lisp/tab-bar.el (tab-bar-select-tab-modifiers): Mention
tab-bar-tab-hints in docstring.
(tab-bar-tab-hints): Mention tab-bar-select-tab-modifiers
in docstring.
(tab-bar-select-tab): Mention tab-bar-select-tab-modifiers
in docstring.
(tab-bar-switch-to-tab): Expand the docstring.
(tab-bar-new-tab-to): Fix bug in handling 'left' value.
(tab-bar-close-tab): Fix bug in handling 'left' value.
(tab-bar-undo-close-tab): Use funcall tab-bar-tabs-function
instead of direct call to tab-bar-tabs.
(tab-bar-history-back, tab-bar-history-forward): Add docstrings.
(tab-bar-history-mode): Expand docstring.

* lisp/tab-line.el (tab-line-format): Fix bug for handling window
switching that should set face 'tab-line-tab-current'.
2020-04-27 01:28:36 +03: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
Juri Linkov
ba6104d1e8 Change doc-view-mode-map prefix key 's' to 'c'.
* doc/emacs/misc.texi (DocView Slicing): Change prefix key 's' to 'c'.

* lisp/doc-view.el (doc-view-mode-map): Change prefix key 's' to 'c'.

* lisp/image-mode.el (image-mode-map): Add image-transform-set-scale to menu.

* doc/emacs/files.texi (Image Mode): Describe commands
image-transform-fit-both, image-transform-set-scale, image-transform-reset.

* etc/NEWS: Rearrange image sections.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01315.html
2020-04-23 02:14:42 +03: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
Eli Zaretskii
fc55f65305 Minor improvements in documentation of the last change
* etc/NEWS:
* doc/emacs/files.texi (Image Mode): Minor copyedits of last change.
2020-04-21 16:50:13 +03:00
Juri Linkov
a64da75961 Add image-auto-resize defcustoms to image-mode.el
* lisp/image-mode.el (image-auto-resize)
(image-auto-resize-on-window-resize): New defcustoms.
(image-mode-map): Bind "sb" to image-transform-fit-both.
(image-mode): Set image-transform-resize to image-auto-resize initially.
(image-mode--setup-mode): Add hook on image-auto-resize-on-window-resize.
(image-toggle-display-image): Check if image-transform-resize is t.
(image-transform-properties): Check image-transform-resize for nil and t.
(image-transform-fit-both): New command.
(image-transform-reset): Reset image-transform-resize to image-auto-resize.

* doc/emacs/files.texi (Image Mode): Mention image-auto-resize and
image-auto-resize-on-window-resize.

https://lists.gnu.org/archive/html/emacs-devel/2020-04/msg01160.html
2020-04-21 02:42:16 +03:00
Juri Linkov
692ad40539 Improve the documentation of tab-bar and tab-line
* doc/emacs/frames.texi (Tab Bars): Add xref to "Tab Line".
Document more commands.

* doc/emacs/windows.texi (Windows):
* doc/emacs/emacs.texi (Top): Add "Tab Line" menu.

* doc/emacs/windows.texi (Window Convenience):
Move tab-line documentation to new node "Tab Line".
(Tab Line): New node.

* doc/emacs/glossary.texi (Glossary):
* doc/emacs/modes.texi (Minor Modes):
* doc/emacs/display.texi (Standard Faces): Add xref to "Tab Line".
2020-04-21 02:23:35 +03: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
Juri Linkov
9261a219ec * doc/emacs/windows.texi (Window Convenience): Decribe more windmove features.
* doc/emacs/windows.texi (Window Convenience): Add descriptions of
windmove-display-default-keybindings,
windmove-delete-default-keybindings,
windmove-swap-states-in-direction.

* etc/NEWS: Regroup to move some parts closer to related sections.
2020-04-20 01:57:32 +03: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