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

2919 commits

Author SHA1 Message Date
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
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
Eli Zaretskii
f90a3360d8 Backport doc improvement in ELisp manual
* doc/lispref/processes.texi (Accepting Output): Backport:
document how do avoid race conditions while waiting for all of
the process's output to arrive.
2019-04-20 10:21:02 +03:00
Eli Zaretskii
beb4eac654 * doc/lispref/display.texi (Showing Images): Fix a typo. (Bug#35240 2019-04-12 21:46:25 +03:00
Eli Zaretskii
85829363f7 Improve documentation of 'read-command'
* src/minibuf.c (Fread_command): Document the return value
when DEFAULT-VALUE is nil and the user enters nothing.
* doc/lispref/minibuf.texi (High-Level Completion): Document
the printed representation of a symbol whose name is empty.
(Bug#3522)
2019-04-11 17:00:44 +03:00
Alex Branham
559f64a0b6 Backport: Update documentation for indent-relative functions
* lisp/indent.el (indent-relative): Document what happens when there
  is no previous nonblank line.
* doc/lispref/text.texi (Relative Indent): Document
  indent-relative-first-indent-point instead of obsolete
  indent-relative-maybe. Fix documentation of which argument from
  'indent-relative' is used.

Bug#34858

(cherry picked from commit 10cd65878c)
2019-04-11 11:41:06 +01:00
Eli Zaretskii
a30a6c3019 Improve documentation of set-window-start
* doc/lispref/windows.texi (Window Start and End):
* src/window.c (Fset_window_start): Document that reliable
setting of a window start position requires to adjust point to
be visible.  (Bug#34038)
2019-04-06 11:22:13 +03:00
Eli Zaretskii
92ce2dd48b Improve documentation of window parameters
* doc/lispref/windows.texi (Cyclic Window Ordering): Describe
the effect of the 'other-window' window parameter.
(Window Parameters): Improve the descriptions of window
parameters.  Move the detailed description of the
'quit-restore' window parameter from here...
(Quitting Windows): ...to here.  (Bug#35063)
2019-04-06 11:04:37 +03:00
Paul Eggert
0924b27bca Say which regexp ranges should be avoided
* doc/lispref/searching.texi (Regexp Special): Say that
regular expressions like "[a-m-z]" and "[[:alpha:]-~]" should
be avoided, for the same reason that regular expressions like
"+" and "*" should be avoided: POSIX says their behavior is
undefined, and they are confusing anyway.  Also, explain
better what happens when the bound of a range is a raw 8-bit
byte; the old explanation appears to have been obsolete
anyway.  Finally, say that ranges like "[\u00FF-\xFF]" that
mix non-ASCII characters and raw 8-bit bytes should be
avoided, since it’s not clear what they should mean.
2019-03-20 14:44:14 -07:00
Martin Rudalics
bc75589b90 Document restrictions when setting window margins, fringes or scroll bars
* src/window.c (Fset_window_margins, Fset_window_fringes)
(Fset_window_scroll_bars): In doc-strings tell that a window
must be large enough to accommodate fringes, sroll bars and
margins of the desired size.
* doc/lispref/display.texi (Fringe Size/Pos, Scroll Bars)
(Display Margins): Tell that windows must be large enough to
accommodate fringes, sroll bars and margins of the desired
size.
2019-03-13 10:45:28 +01:00
Eli Zaretskii
0589de55c4 Fix markup of fake keys in the ELisp manual
* doc/lispref/keymaps.texi (Menu Bar, Tool Bar): Fix markup of
fake keys.  (Bug#34785)
2019-03-09 13:20:28 +02:00
Michael Albinus
a3b193516f Mention empty strings in file name expansion, emacs lisp reference
* doc/lispref/files.texi (Files, File Name Expansion):
Mention also empty strings.
2019-03-09 09:47:07 +01:00
Martin Rudalics
464ee80eac Warn against recursive invocations of 'buffer-list-update-hook' (Bug#34765)
* src/buffer.c (Vbuffer_list_update_hook):
* doc/lispref/buffers.texi (Buffer List): Warn against
recursive invocations of 'buffer-list-update-hook' (Bug#34765).
2019-03-08 19:10:27 +01:00
Eli Zaretskii
52fd40068e Minor improvement of documentation of '(when CONDITION . SPEC)'
* doc/lispref/display.texi (Other Display Specs): Add a caveat
to using the '(when CONDITION . SPEC)' display specs.
2019-03-04 19:49:47 +02:00
Eli Zaretskii
f872b65b2f Improve documentation of 'auto-coding-functions'
* doc/lispref/nonascii.texi (Default Coding Systems): Clarify
that the functions in 'auto-coding-functions' are called both
for decoding and for encoding.

* lisp/international/mule.el (auto-coding-functions): Doc fix.
2019-03-02 10:42:29 +02:00
Basil L. Contovounesios
a89fabe963 Update example major mode code in Elisp manual
* doc/lispref/modes.texi (Example Major Modes): Update code examples
to reflect current state of lisp/textmodes/text-mode.el and
lisp/emacs-lisp/lisp-mode.el. (bug#34671)
2019-03-02 09:19:00 +02:00
Eli Zaretskii
f3dab02232 Minor improvement in cross-references of the ELisp manual
* doc/lispref/modes.texi (Minor Mode Conventions): Add
cross-references to related major-mode descriptions.  (Bug#34678)
2019-03-01 12:25:40 +02:00
Eli Zaretskii
dee3cdc504 Minor improvement for docs of completion
* doc/lispref/minibuf.texi (Completion Commands)
(Completion in Buffers, Programmed Completion): Add to text
that references completion tables a cross-reference to where
"completion table" is described.
(Programmed Completion): Fix the description of
'completion-table-dynamic'.  Add more cross-references.
2019-02-23 15:31:15 +02:00
Eli Zaretskii
76ef80591b Fix a typo in ELisp manual
* doc/lispref/abbrevs.texi (Abbrev Table Properties): Fix a
typo.  (Bug#34508)
2019-02-17 17:30:40 +02:00
Paul Eggert
b5e66f46a6 Update citations of Internet RFCs
For example, RFC 822 has been obsoleted by RFC 2822, which in
turn has been obsoleted by RFC 5322.
* doc/emacs/ack.texi, doc/lispref/os.texi:
* doc/misc/emacs-mime.texi, doc/misc/gnus-coding.texi:
* doc/misc/gnus.texi, doc/misc/sc.texi:
* lisp/calendar/parse-time.el, lisp/gnus/gnus-cite.el:
* lisp/gnus/gnus-util.el, lisp/gnus/message.el:
* lisp/gnus/mm-bodies.el, lisp/gnus/nnrss.el:
* lisp/mail/feedmail.el, lisp/mail/ietf-drums.el:
* lisp/mail/mail-extr.el, lisp/mail/mail-utils.el:
* lisp/mail/mailclient.el, lisp/mail/mailheader.el:
* lisp/mail/rfc2047.el, lisp/mail/rfc822.el, lisp/mail/rmail.el:
* lisp/mail/sendmail.el, lisp/mail/smtpmail.el:
* lisp/mail/supercite.el, lisp/mh-e/mh-e.el:
* lisp/mh-e/mh-utils.el, lisp/net/imap.el:
* lisp/net/newst-backend.el, lisp/org/org-id.el:
* lisp/ps-samp.el, lisp/simple.el, lisp/url/url-util.el:
Update RFC citations.
2019-02-16 12:00:02 -08:00
Eli Zaretskii
12b794044a Fix a typo in lispref/syntax.texi
* doc/lispref/syntax.texi (Syntax Table Internals): Fix a
typo.  (Bug#34495)
2019-02-16 09:05:19 +02:00
Eli Zaretskii
b384996e86 Minor fixes in ELisp manual wrt syntax-table properties
* doc/lispref/syntax.texi (Syntax Properties): Fix reference
to syntax-table properties.  (Bug#34455)
(Control Parsing): Remove redundant @vindex entry.
2019-02-12 19:32:55 +02:00
Eli Zaretskii
b8c70172f3 Improve documentation of 'date-to-time' and 'parse-time-string'
* doc/lispref/os.texi (Time Parsing): Document
'parse-time-string', and refer to it for the description of
the argument of 'date-to-time'.

* lisp/calendar/time-date.el (date-to-time): Refer in the doc
string to 'parse-time-string' for more information about the
format of the DATE argument.  (Bug#34303)
2019-02-08 10:33:13 +02:00
Eli Zaretskii
e9ff190531 * doc/lispref/tips.texi (Documentation Tips): Fix quotes. (Bug#34372) 2019-02-07 19:49:57 +02:00
Alex Branham
b657286a8c
Add documentation for tabulated-list functions in the elisp manual
* doc/lispref/modes.texi: Add documentation for
  'tabulated-list-delete-entry', 'tabulated-list-get-id',
  'tabulated-list-get-entry', 'tabulated-list-header-overlay-p',
  'tabulated-list-put-tag', and 'tabulated-list-set-col'.

Bug#21074
2019-02-05 14:49:10 -06:00
Eli Zaretskii
73508e6245 Improve documentation of face numbers
* doc/lispref/display.texi (Face Functions): Mention where the
face number is used and that it depends on the 'face' property
of the face symbol.  Improve indexing.
2019-01-29 18:28:13 +02:00
Eli Zaretskii
b6d78a0d80 Fix a typo in ELisp manual
* doc/lispref/nonascii.texi (Converting Representations): Fix
inconsistency between @defun and the argument description of
'byte-to-string'.  (Bug#34119)
2019-01-18 10:51:57 +02:00
Eli Zaretskii
03818b0a95 Fix a minor mistake in ELisp manual
* doc/lispref/buffers.texi (Modification Time): Fix
documentation of 'visited-file-modtime'.  (Bug#34055)
2019-01-13 17:40:50 +02:00
Paul Eggert
2fcf2dff00 Fix copyright years by hand
These are dates that admin/update-copyright did not update, or
updated incorrectly.
2019-01-01 01:02:40 +00:00
Paul Eggert
26bed8ba10 Update copyright year to 2019
Run 'TZ=UTC0 admin/update-copyright $(git ls-files)'.
2019-01-01 01:01:13 +00:00
Eli Zaretskii
2e8825d6c5 Improve documentation of 'file-local-name' and related APIs
* doc/lispref/files.texi (Unique File Names)
(Magic File Names, File Name Expansion): Improve documentation
of the "local part" of a remote file name.
* doc/lispref/processes.texi (Synchronous Processes)
(Asynchronous Processes): State explicitly that program and
file names passed to functions that start remote processes
need to be relative or obtained by 'file-local-name'.

* lisp/files.el (file-local-name):
* lisp/simple.el (start-file-process, process-file): Improve
the documentation of the "local part" of a remote file name,
and its use in APIs that start remote processes.
2018-12-29 17:34:57 +02:00
Paul Eggert
c9fdd1b496 Improve accept-process-process doc
* doc/lispref/processes.texi (Accepting Output):
* src/process.c (Faccept_process_output):
Document that (accept-process-output P) can return non-nil
even after P has exited, and that it can return nil even if P
is still running (Bug#33839).
2018-12-27 12:53:54 -08:00
Michael Albinus
0f9be72701 Clarify thread switching while waiting for process output
* doc/lispref/threads.texi (Threads): Clarify, that thread
switching happens when waiting for process output from
asynchronous processes.
2018-12-23 09:04:37 +01:00
Charles A. Roelli
24ddea074a Improve process doc. with respect to handling of large input (Bug#33191)
* src/process.c (Fprocess_send_region, Fprocess_send_string):
Document that process input longer than the process input
buffer may be split into bunches.  Remove an outdated
reference to a 500 character split boundary.
* doc/lispref/processes.texi (Asynchronous Processes): Remove
mention of "stray character injections" in PTY processes.  See
also the comment about ICANON in src/sysdep.c, function
child_setup_tty.
2018-12-22 17:14:36 +01:00
Martin Rudalics
5d1b158feb Tiny markup fix in Elisp manual
* doc/lispref/lists.texi (Building Lists): Use '@var' instead
of '@code' for argument.
2018-12-11 09:16:21 +01:00
Eli Zaretskii
908af9dfc4 Indexing followup to recent changes
* doc/lispref/text.texi (Special Properties): Index
'cursor-sensor-inhibit'.  (Bug#33664)
2018-12-09 17:14:55 +02:00
Stefan Monnier
505ac9a0b1 Improve documentation of cursor-sensor.el (bug#33664)
* doc/lispref/text.texi (Special Properties): Mention cursor-sensor-inhibit.
* lisp/emacs-lisp/cursor-sensor.el (Commentary): Add cursor-sensor-mode.
(cursor-sensor-inhibit): Add docstring.
2018-12-09 08:59:20 -05:00
Stefan Monnier
d817d2cfb9 * doc/lispref/commands.texi (Adjusting Point): Bug#33662
Tweak text to clarify intangibility.
2018-12-09 08:34:35 -05:00
Eli Zaretskii
2b9e9937b4 ; * doc/lispref/text.texi (Special Properties): Fix wording. (Bug#33663) 2018-12-07 17:14:32 +02:00
Martin Rudalics
c7897c2786 A few further fixes of window internals description
* doc/lispref/internals.texi (Window Internals): Add a few
more items and clarify description of some others.
2018-12-03 09:35:33 +01:00
Eli Zaretskii
911766d419 Minor markup fix in frames.texi
* doc/lispref/frames.texi (Frame Layout): Fix markup of @table
entries.  (Bug#33531)
2018-11-28 09:22:00 +02:00
Eli Zaretskii
56e3e4fe68 Improve indexing in the ELisp manual
* doc/lispref/control.texi (Control Structures, Sequencing)
(Conditionals, Iteration, Catch and Throw, Handling Errors)
(Cleanups):
* doc/lispref/eval.texi (Self-Evaluating Forms)
(Symbol Forms, Function Forms, Macro Forms, Special Forms)
(Quoting, Backquote): Add index entries that begin with
"forms".  (Bug#33440)
2018-11-24 10:00:55 +02:00
Eli Zaretskii
0d59ae3f49 Update the docs of object internals
* doc/lispref/internals.texi (Buffer Internals)
(Window Internals, Process Internals): Update the descriptions
of Lisp objects.
2018-11-20 20:45:07 +02:00
Eli Zaretskii
60457d7ae0 Improve documentation of the window tree
* doc/lispref/windows.texi (Windows and Frames): More accurate
wording regarding the relation of a mini-window to its frame's
window tree.

* src/window.h (struct window): Improve commentary to some
fields.
2018-11-19 20:31:49 +02:00
Martin Rudalics
7252507699 Fix description of some window hooks
* doc/lispref/windows.texi (Window Hooks): Remove text that
warns against using 'save-window-excursion' while running
'window-size-change-functions', it's no more relevant.
Clarify description of 'window-configuration-change-hook'.
2018-11-18 09:24:10 +01:00
Markus Triska
edcd6b722c Small documentation correction.
* doc/lispref/windows.texi (Textual Scrolling): In the description of
scroll-up-aggressively, refer to scroll-down-aggressively instead of
a recursive reference to scroll-up-aggressively.  (Bug#33369)
2018-11-14 18:05:31 +02:00
Charles A. Roelli
c7b8a51b79 ; * doc/lispref/functions.texi (Anonymous Functions): Fix typo. 2018-11-10 20:32:36 +01:00
Noam Postavsky
39e85a0c6c Note that lex bound lambda forms are not self-quoting (Bug#33199)
* doc/lispref/functions.texi (Anonymous Functions):
* lisp/subr.el (lambda): Note that under lexical binding a lambda form
yields a closure object (Bug#33199).
2018-11-08 20:13:56 -05:00