1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-02-06 15:41:27 -08:00
Commit graph

6751 commits

Author SHA1 Message Date
Eli Zaretskii
0860ac0e9d Improve documentation of features that use the fringes
* doc/emacs/display.texi (Fringes): Add cross-reference to
where indicate-empty-lines is described.
(Useless Whitespace): Add an @anchor for a more accurate
cross-reference in "Fringes".
2019-08-10 12:48:03 +03:00
Basil L. Contovounesios
e7818cb73f Fix nnmail-expiry-wait docs and custom :types
* doc/misc/gnus.texi (Group Parameters, Expiring Mail):
* lisp/gnus/gnus-cus.el (gnus-group-parameters): Clarify
descriptions of nnmail-expiry, nnmail-expiry-wait, and
nnmail-expiry-wait-function.
* lisp/gnus/nnmail.el (nnmail-expiry-wait)
(nnmail-expiry-wait-function): Clarify docstrings and fix custom
:types (bug#36850).
2019-08-03 15:29:12 +03:00
Eli Zaretskii
5a5ad99d2f Improve documentation of debugging Lisp syntax error
* doc/lispref/debugging.texi (Syntax Errors, Excess Open)
(Excess Close): Name the commands invoked by the key
sequences.  Add cross-references to appropriate sections of
the Emacs manual.  (Bug#21385)

(cherry picked from commit faafd467a3)
2019-08-03 12:43:10 +03:00
Eli Zaretskii
8fbe46252f ; * doc/lispref/positions.texi (List Motion): Fix last change. 2019-07-30 17:50:32 +03:00
Noam Postavsky
1d9efc0b3a Add index for "\( in strings" (Bug#25195)
* doc/emacs/programs.texi (Left Margin Paren): Add index for "\( in
strings".
* doc/lispref/positions.texi (List Motion): Add index, and cross
reference.
2019-07-30 09:06:18 -04:00
Stefan Kangas
16a529e215 Remove upload functionality of package-x from the elisp manual
Suggested by Stefan Monnier.
Ref: https://debbugs.gnu.org/cgi/bugreport.cgi?bug=19537#8

* doc/lispref/package.texi (Package Archives): Don't document
package-x upload functions in the elisp manual, since they are not
very commonly used.  (Bug#19537)
* lisp/emacs-lisp/package-x.el (package-archive-upload-base)
(package-upload-buffer, package-upload-file): Add to the doc strings
any details removed from the elisp manual that would otherwise be
missing.
2019-07-25 18:23:55 -04:00
Basil L. Contovounesios
086a56ed43 Clarify Gravatar docs
For discussion, see the following thread:
https://lists.gnu.org/archive/html/emacs-devel/2019-07/msg00528.html
* doc/misc/gnus.texi (X-Face): Fix cross-reference.
(Gravatars):
* lisp/gnus/gnus-gravatar.el (gnus-gravatar-too-ugly):
* lisp/image/gravatar.el (gravatar-cache-ttl, gravatar-rating)
(gravatar-size): Clarify user option descriptions.
(gravatar-retrieve, gravatar-retrieve-synchronously): Document
return value.
2019-07-23 09:30:39 +01:00
Alan Mackenzie
05924677f0 * doc/lispref/display.texi (Defining Faces): Say a face can't be undefined. 2019-07-22 14:57:41 +00:00
N. Jackson
021f32cca1 * doc/misc/forms.texi (Control File Format): Fix a doc error.
(Bug#36693)

Copyright-paperwork-exempt: yes
2019-07-20 12:53:10 +03:00
Markus Triska
b2fde4b5e8 * doc/lispref/text.texi (Mode-Specific Indent): Fix a typo (bug#36646). 2019-07-14 10:56:38 +03:00
Eli Zaretskii
1e6d8e003c ; * doc/emacs/killing.texi (Secondary Selection): Fix last change. 2019-07-06 21:33:45 +03:00
Eli Zaretskii
ff738ab8b8 Minor copyedit of "Font Lock" in user manual
* doc/emacs/display.texi (Font Lock): Make the wording about
"enabling Font Lock" crystal clear.  (Bug#36529)
2019-07-06 17:25:46 +03:00
Eli Zaretskii
faf99dcb37 Improve description of image descriptors
* doc/lispref/display.texi (Image Descriptors): More accurate
description of where image files are looked up.  (Bug#36523)
2019-07-06 15:32:20 +03:00
Eli Zaretskii
d176090fc2 Improve documentation of secondary selections
* doc/emacs/killing.texi (Secondary Selection): Improve
wording.  Mention that 'M-mouse-1' can be used to cancel
secondary selections.  (Bug#36365)
2019-07-06 11:30:35 +03:00
Stefan Kangas
13b95e1cc7 Fix typo in windows.texi
* doc/lispref/windows.texi (Window History): Fix typo.  (Bug#36412)
2019-06-28 10:38:08 +03:00
Basil L. Contovounesios
8b775c30ad Clarify & update (elisp) Writing Emacs Primitives
* doc/lispref/internals.texi (Writing Emacs Primitives): Update some
of the sample code listings, fixing argument lists and parentheses.
Replace ... with @dots{}.  Describe UNEVALLED special forms as
taking a single argument. (bug#36392)
2019-06-26 22:16:52 +01:00
Eli Zaretskii
7648c125df Clarify a subtle issue in the Internals chapter of lispref
* doc/lispref/internals.texi (Writing Emacs Primitives):
Clarify the issue with relocation of buffer or string text as
side effect of Lisp evaluation.  (Bug#36392)
2019-06-26 18:02:26 +03:00
Juanma Barranquero
572e34bb6f Rename 'make-symbolic-link' argument NEWNAME to LINKNAME
* src/fileio.c (Fmake_symbolic_link): Fix docstring.
* doc/lispref/files.texi (Changing Files): Doc fix.
2019-06-21 21:42:36 +02:00
Eli Zaretskii
4701e0663e Improve wording of documentation of click events
* doc/lispref/commands.texi (Click Events, Accessing Mouse):
Improve and clarify wording.  (Bug#36232)
2019-06-16 18:29:21 +03:00
Mattias Engdegård
bea31a3794 Backport: Fix typo in regexp-opt example code
* doc/lispref/searching.texi (Regexp Functions):
Fix typo in example code (Bug#34596).
2019-06-16 11:48:38 +02:00
Martin Rudalics
eca2677b1d Fix description of 'display-buffer-in-previous-window' again (Bug#36161)
* lisp/window.el (display-buffer-in-previous-window): Make
doc-string more explicit (Bug#36161).
* doc/lispref/windows.texi (Buffer Display Action Functions):
Make description of 'display-buffer-in-previous-window' more
explicit.
(Buffer Display Action Alists): Mention
'display-buffer-in-previous-window' in description of
'reusable-frames' entry.
2019-06-12 11:02:02 +02:00
Eli Zaretskii
7be50cda56 Consistently use @minus{} for negative arguments
* doc/emacs/mark.texi (Marking Objects):
* doc/misc/gnus.texi (Selecting a Group):
* doc/emacs/programs.texi (Comment Commands):
* doc/emacs/killing.texi (Deletion):
* doc/emacs/display.texi (Recentering):
* doc/lispref/display.texi (Face Attributes):
* doc/lispref/searching.texi (String Search, Regexp Search):
Make the markup of "-N" use @minus{} uniformly.  (Bug#35885)
2019-06-11 19:55:14 +03:00
Martin Rudalics
5ca093d281 Fix doc of 'display-buffer-in-previous-window' (Bug#36161)
* doc/lispref/windows.texi (Buffer Display Action Functions):
* lisp/window.el (display-buffer-in-previous-window): Tell
that 'display-buffer-in-previous-window' prefers
non-selected windows (Bug#36161).
2019-06-11 09:28:29 +02:00
Eli Zaretskii
4904fb352c More quotation fixes (Bug#35885)
* doc/emacs/text.texi (Quotation Marks): Fix a typo.
* doc/emacs/modes.texi (Minor Modes): Fix another case of
showing quotations.
2019-06-09 11:28:36 +03:00
Eli Zaretskii
b58ecafcdc Minor copyedits in efaq-w32
* doc/misc/efaq-w32.texi (Grep, Recursive grep): More accurate
description of using 'findstr' as a poor-man's replacement for
'grep'.  Reported by 范凯 <m_pupil@163.com>
2019-06-08 18:48:33 +03:00
Eli Zaretskii
48422af0f3 Tiny improvement of documentation of major mode conventions
* doc/lispref/modes.texi (Major Mode Conventions): More
accurate advice regarding customization of 'C-M-a' by major
modes.
2019-06-08 11:24:47 +03:00
Eli Zaretskii
f68b33f502 Fix styling of Unicode codepoints in manuals
* doc/lispref/nonascii.texi (Character Properties):
* doc/lispref/display.texi (Glyphless Chars)
(Bidirectional Display):
* doc/emacs/search.texi (Lax Search):
* doc/emacs/text.texi (Quotation Marks):
* doc/emacs/basic.texi (Inserting Text): Canonicalize the
style of "U+NNNN CHARACTER NAME".  (Bug#35885)
2019-06-05 19:52:00 +03:00
Eli Zaretskii
ff7ec6ff33 Fix a few uses of quotes in user manual
* doc/emacs/text.texi (Quotation Marks):
* doc/emacs/display.texi (Text Display):
* doc/emacs/basic.texi (Inserting Text): Fix some more
quotes.  (Bug#35885)
2019-06-04 18:11:37 +03:00
Eli Zaretskii
b67042be5d More minor copyedits in the Emacs manual
* doc/emacs/basic.texi (Arguments):
* doc/emacs/display.texi (Recentering, Text Display):
* doc/emacs/regs.texi (Text Registers, Rectangle Registers):
* doc/emacs/mark.texi (Disabled Transient Mark): Fix
inaccuracies and typos.  (Bug#35885)
2019-06-03 19:30:47 +03:00
Eli Zaretskii
9734b5c5b2 Fix minor issues in the Emacs manual
* doc/emacs/search.texi (Regexp Replace, Regexps):
* doc/emacs/kmacro.texi (Keyboard Macro Query)
(Save Keyboard Macro): Fix inaccuracies and typos.
(Bug#35885)
2019-06-03 19:11:42 +03:00
Martin Rudalics
c153250adb Try to improve text on atomic windows in Elisp manual
* doc/lispref/windows.texi (Deleting Windows): Mention how
'delete-window' and 'delete-other-windows' handle atomic
windows.  Minor rewrite.
(Quitting Windows): Mention how 'quit-restore-window' handles
atomic windows and that it tries to avoid raising an error.
(Atomic Windows): Tell how to dissolve atomic windows.
2019-06-03 10:36:00 +02:00
Noam Postavsky
fb314ba3ad Don't recommend insert-before-markers in process filters
See <https://lists.gnu.org/r/emacs-devel/2019-05/msg00062.html> and
Bug#35334.
* doc/lispref/processes.texi (Filter Functions): Go back to using
plain insert in the example filter.  Add note about updating window
point.
2019-06-01 17:48:43 -04:00
Eli Zaretskii
d8a6d82c4d Improve documentation of 'safe-local-variable' property
* doc/lispref/variables.texi (File Local Variables): Document
how to define 'safe-local-variable' properties for built-in
variables.
2019-06-01 10:28:30 +03:00
Noam Postavsky
2168165ec0 ; * doc/lispref/nonascii.texi (Explicit Encoding): Fix typo. 2019-05-26 08:46:30 -04:00
Eli Zaretskii
8f18d12121 Improve documentation of decoding into a unibyte buffer
* doc/lispref/nonascii.texi (Explicit Encoding): Document what
happens when DESTINATION of decoding is a unibyte buffer.

* src/coding.c (Fdecode_coding_region)
(Fdecode_coding_string): Document what happens if DESTINATION
is a unibyte buffer.
2019-05-25 22:10:00 +03:00
Mauro Aranda
7681a57b88 Remove redundants "See" before @xref or @pxref (Bug#35793)
* doc/lispref/control.texi (Control Structures):
* doc/lispref/modes.texi (Search-based Fontification):
* doc/misc/cc-mode.texi (Filling and Line Breaking Commands)
(Auto-newline Insertion, Other Special Indentations):
* doc/misc/dbus.texi (Errors and Events):
* doc/misc/dired-x.texi (Find File At Point):
* doc/misc/eudc.texi (Display of Query Results, Inline Query Expansion):
* doc/misc/gnus-faq.texi (FAQ 3-11):
* doc/misc/gnus.texi (Group Parameters, Posting Styles)
(Spam Package Introduction):
* doc/misc/org.texi (LaTeX fragments, Previewing LaTeX fragments):
* doc/misc/reftex.texi (Commands):
Remove redundant "See" before cross references.
* doc/lispref/functions.texi (Function Safety): Redundant "see" is in
ignored text, but remove it anyway.
* doc/lispref/positions.texi (Skipping Characters): Remove redundant
"See" before cross references.  Change @xref to @pxref, which is
more suitable when at the end of a sentence.

Most of the redundants "See" found by Noam Postavsky.
2019-05-25 13:02:05 -04:00
Tom Levy
b0da9151d8 Fix a typo in ELisp manual
* doc/lispref/sequences.texi (Sequence Functions): Fix a typo.
(Bug#35817)

Copyright-paperwork-exempt: yes
2019-05-22 13:13:04 +03:00
Noam Postavsky
400907b3c1 Add option to disable help completion autoloading (Bug#28607)
* lisp/help-fns.el (help-enable-completion-auto-load): New option.
(help--symbol-completion-table): Consult it.
* doc/emacs/building.texi (Lisp Libraries): Document it.
* etc/NEWS: Announce it.
* doc/lispref/loading.texi (Autoload by Prefix): New section.
(Autoload): Reference it.
2019-05-21 07:37:22 -04:00
Mauro Aranda
015b12ebb8 Fix typo in ELisp manual
* doc/lispref/variables.texi (Directory Local Variables): Fix typo in
dir-locals-set-class-variables description.  (Bug#35799)
2019-05-20 14:22:58 -04:00
Basil L. Contovounesios
6cfd68d4d7 Fix Hideshow key binding typo in Emacs manual
* doc/emacs/programs.texi (Hideshow): Add missing function and key
index entries.  Fix hs-toggle-hiding binding typo. (bug#35798)
2019-05-19 13:52:26 +01:00
Neil Roberts
02bee7860f Let dir locals for more specific modes override those from less
The list of dir local variables to apply is now sorted by the number
of parent modes of the mode used as the key in the association list.
That way when the variables are applied in order the variables from
more specific modes will override those from less specific modes.

If there are directory entries in the list then they are sorted in
order of name length.  The list of modes for that dir is then
recursively sorted with the same mechanism.  That way variables tied
to a particular subdirectory override those in in a parent directory.

Previously the behaviour didn’t seem to be well defined anyway and was
dependent on the order they appeared in the file.  However this order
was changed in version 26.1 and it probably also depended on the
number of dir-local files that are merged.

Bug#33400

* lisp/files.el (dir-locals-get-sort-score, dir-locals-sort-variables)
(dir-locals-read-from-dir): Sort the dir locals so that more precise
modes and directory-specific entries have override lesser ones.
* doc/emacs/custom.texi (Directory Variables): Document the priority.
2019-05-12 09:59:55 -04:00
Eli Zaretskii
b1235f9abd Improve documentation of Hexl mode
* doc/emacs/misc.texi (Editing Binary Files): Clarify
"insertion".  Improve wording.  Add a few Hexl commands.
(Bug#35580)
2019-05-11 15:00:06 +03:00
Alan Mackenzie
32d181326a Fix description of (move-to-column <n> t) when column <n> is inside a tab
This fixes bug #35647.  State that when indent-tabs-mode is non-nil, spaces
are inserted before the tab rather than the tab being replaced by spaces.

* doc/lispref/text.texi (columns)
* src/indent.c (move-to-column): Make the above documentation amendment.
2019-05-09 16:27:03 +00:00
Noam Postavsky
3b86e0b812 Clarify handling of long options (Bug#24949)
* doc/emacs/cmdargs.texi (Emacs Invocation): Note that space can be
used instead of "=" only if an option requires an argument.
2019-05-04 23:55:50 -04:00
Eli Zaretskii
04340a8e2f Improve documentation of the daemon and emacsclient
* doc/emacs/misc.texi (emacsclient Options):
* doc/emacs/cmdargs.texi (Initial Options): Document that
using --daemon=NAME will need to specify the same NAME when
invoking 'emacscilent'.  (Bug#35547)
2019-05-04 12:22:49 +03:00
Noam Postavsky
ec02c736d6 Update process filter example (Bug#35044)
* doc/lispref/processes.texi (Filter Functions): Use
insert-before-markers in the "ordinary" filter example, like
internal-default-process-filter does.
2019-04-30 20:51:24 -04:00
Noam Postavsky
140e7f890f Recommend using font-lock-face over face (Bug#35044)
* doc/lispref/modes.texi (Precalculated Fontification): Explain
advantages of using font-lock-face over face.
2019-04-28 17:20:17 -04:00
Charles A. Roelli
0e8d452c1c ; * doc/lispref/nonascii.texi (Coding System Basics): Fix grammar. 2019-04-26 21:49:46 +02:00
Michael Albinus
25a2ff72d0 ; Add missing space in custom.texi 2019-04-25 22:49:03 +02:00
Basil L. Contovounesios
3988e93d4b Backport: Improve pure and side-effect-free docs
For discussion, see thread starting at:
https://lists.gnu.org/archive/html/emacs-devel/2019-04/msg00316.html
* doc/lispref/customize.texi (Composite Types): Do not overspecify
:match-alternatives predicates.
* doc/lispref/eval.texi (Intro Eval): Anchor definition of "side
effect" for cross-referencing...
* doc/lispref/functions.texi (What Is a Function): ...from here.
Define what a pure function is.
* doc/lispref/internals.texi (Writing Emacs Primitives): Describe
currently preferred approach to marking primitives as pure and
side-effect-free.
* doc/lispref/symbols.texi (Standard Properties): Expand description
of pure and side-effect-free properties.

(cherry picked from commit 4430a9b54f)
2019-04-22 16:14:33 +01:00