1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-01-30 20:32:00 -08:00
Commit graph

6708 commits

Author SHA1 Message Date
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
Eli Zaretskii
75b589c7d2 Fix markup related to quoting in Info
* doc/misc/sc.texi (Citations): Fix markup of '>'.
* doc/misc/mh-e.texi (Speedbar): Fix markup in a @table.
* doc/misc/calc.texi (Yacas Language Mode): Fix a typo.
* doc/emacs/mark.texi (Setting Mark): Remove duplicate
quoting.  (Bug#35202)
2019-04-21 14:56:04 +03: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
Robert Pluim
d0f745f67a Document some compilation-mode faces
* doc/emacs/building.texi (Compilation Mode): Describe faces
available to affect appearance of compilation-mode buffers.
2019-04-16 18:07:31 +02:00
Eli Zaretskii
23ccba0cf9 Mention the assignment form in "Copyright Assignment"
* doc/emacs/trouble.texi (Copyright Assignment): Mention the
copyright assignment form explicitly.  Suggested by Konstantin
Kharlamov <hi-angel@yandex.ru>.
2019-04-16 18:32:18 +03:00
Eli Zaretskii
0f5568ea7c Fix confusing wording in the user manual
* doc/emacs/maintaining.texi (VC Undo): Remove a potentially
inaccurate, outdated, and/or confusing sentence.  (Bug#35290)
2019-04-16 18:27:37 +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
Noam Postavsky
cb5a340823 Update nxml-mode.texi: completion now gives xmlns="-!-"
* doc/misc/nxml-mode.texi (Completion): As of 2016-01-16 "* lisp/nxml:
Use standard completion; it also works for company-mode", completing
an attribute when there is only one candidate inserts both quotes.
Update the example accordingly.
2019-04-10 19:33:21 -04:00
Gemini Lasswell
8d2f1df51a Address name conflicts in EIEIO documentation (bug#31660)
* doc/misc/eieio.texi (Quick Start): Rename the class used in the
example from 'record' to 'person'.
(Building Classes): Advise user to check for name conflicts before
naming a class.  Add a missing apostrophe.
(Making New Objects): Correct grammar.  Rename the class used in the
example from 'record' to 'my-class'.
2019-04-09 18:53:43 -04: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
Eli Zaretskii
0f523deec1 Improve indexing of the user manual
* doc/emacs/search.texi (Word Search): Improve indexing of
"M-s M-w".
2019-03-20 11:29:04 +02:00
Alan Mackenzie
24fc1337c1 * doc/misc/cc-mode.texi (Config Basics): in @itemize, @asis -> @w{} 2019-03-15 11:43:11 +00: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
Alan Mackenzie
a38da0d4e5 cc-mode.texi: Work around makeinfo alignment bug. Fix problem with ss index
* doc/misc/cc-mode.texi (top level): Using txicommandconditionals to
differentiate between the C and perl versions of Texinfo, create an "ss
index" unless we are both using the C Texinfo and are building the .dvi output
format.
(Config Basics): Work around a perl Texinfo alignment bug by writing a
separate version of an item list structure for this version, simplifying it
considerably.
2019-03-08 18:11:21 +00: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
f0be0f1bed Improve documentation of 'delete-windows-on'
* doc/emacs/windows.texi (Change Window): Document
'delete-windows-on'.

* lisp/window.el (delete-windows-on): Doc fix.  (Bug#34749)
2019-03-08 12:21:29 +02:00
Basil L. Contovounesios
099ef446c2
Minor spelling and grammar fixes (bug#34756)
doc/misc/cc-mode.texi (Style Variables, Customizing Indentation):
doc/misc/ede.texi (Extending EDE, ede-project-placeholder)
(ede-target, ede-proj-target, ede-compilation-program, ede-compiler)
(ede-linker): Remove apostrophe from possessive "it's".
doc/lispintro/emacs-lisp-intro.texi (Find a File):
doc/misc/gnus-faq.texi (FAQ 2-2): Write "an other" as a single word.
doc/misc/gnus.texi (Article Buttons):
lisp/gnus/gnus-art.el (gnus-button-mid-or-mail-heuristic-alist)
(gnus-button-mid-or-mail-heuristic): Write singular number of
Message-IDs, rather than plural.
lisp/gnus/message.el (message-user-fqdn): Capitalize initialism.
2019-03-05 20:24:41 +00: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
9df1365f38 Fix a typo in the Calc manual
* doc/misc/calc.texi (Algebraic Tutorial): Fix parentheses in
@example.  (Bug#34689)
2019-03-01 12:30:47 +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
Michael Albinus
d9905d5c6f Document bash 5.0.0 misbehavior in tramp.texi (Bug#34192)
* doc/misc/tramp.texi (Frequently Asked Questions): Warn about
bash 5.0.0 and HISTSIZE=0.  (Bug#34192)
2019-02-21 12:09:44 +01:00
Martin Rudalics
715388acec Fix two warnings in eshell.texi
* doc/misc/eshell.texi (Built-ins, Globbing): Fix `.' or `,'
must follow @xref, not `f' warnings.
2019-02-19 09:55:51 +01: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
Gregor Zattler
7ad0cd6f1e * doc/misc/eshell.texi: Fix some @ref's.
Copyright-paperwork-exempt: yes
2019-02-16 09:28:35 +02: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
Gregor Zattler
834ca187b8 * doc/misc/eshell.texi (Built-ins): Fix alias description
Dear eamcs developers, eshells current documentation first states
that alias definitions are not saved to an alias file, later that
they are saved to an alias file.  I tested it and the latter is
correct.

Please find attached a patch which fixes this.

Thanks for working on emacs which is really great, Gregor

>From 1fe51cc769ab7a30d0896fb3d6105c0561243fa7 Mon Sep 17 00:00:00 2001
From: Gregor Zattler <telegraph@gmx.net>
Date: Wed, 13 Feb 2019 20:19:38 +0100
Subject: * doc/misc/eshell.texi (Built-ins): Fix alias description.

Bring description of built-in 'alias' in line with (info "(eshell) Aliases"),
which describes the actual behaviur.

(cherry picked from commit a48099ce7f)
2019-02-15 09:42:48 +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
Nick Drozd
3b60a0add7 * doc/misc/eww.texi (Basics): Fix eww keybindings. (Bug#34291) 2019-02-08 09:37:30 +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
6c6b540711 Correct the docs of inserting kmacro counter
* doc/emacs/kmacro.texi (Keyboard Macro Counter): Correct the
description of the affect "C-u" has on inserting the macro
counter.  Define "previous counter value".

* lisp/kmacro.el (kmacro-insert-counter)
(kmacro-start-macro-or-insert-counter): Fix the doc strings
regarding the effect of "C-u".  (Bug#34263)
2019-02-01 17:34:23 +02:00
Nicholas Drozd
32555daf4c * doc/misc/calc.texi (Algebraic Tutorial): Fix a typo. (Bug#34273) 2019-02-01 17:11:39 +02:00
Eli Zaretskii
b94d767527 Minor copyedits in last manual change
* doc/emacs/custom.texi (Authentication): Improve markup,
indexing, and wording.
2019-01-29 18:49:50 +02:00