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

6691 commits

Author SHA1 Message Date
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
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
Michael Albinus
bf235ce339 * doc/emacs/custom.texi (Authentication): Refer to the "Help for users" node. 2019-01-27 18:14:44 +01:00
Michael Albinus
ceccb3c8c4 New node Authentication in the Emacs manual
* doc/emacs/custom.texi (Customization):
* doc/emacs/emacs.texi (Top): Add node Authentication.
2019-01-26 16:46:54 +01: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
Glenn Morris
6ac5985418 ; Fix some trivial doc typos 2019-01-12 14:47:33 -08:00
Eli Zaretskii
775517307d Improve documentation of 'server-name'
* doc/emacs/misc.texi (Emacs Server, TCP Emacs server)
(emacsclient Options):
* lisp/server.el (server-name):  Document the usage of
'server-name' to specify the server file as an absolute file
name.  Do not merge to master.  (Bug#33934)
2019-01-04 15:40:43 +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
2814292570 * doc/man/emacs.1.in: Fix value of default frame height. (Bug#33921) 2018-12-31 17:52:01 +02:00
Martin Rudalics
82c82b1c77 In user manual fix value of default frame height (Bug#33921)
* doc/emacs/cmdargs.texi (Window Size X): Fix value of default
frame height (Bug#33921).
2018-12-30 15:21:50 +01: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
Glenn Morris
582527976b * doc/lispintro/emacs-lisp-intro.texi (Finding More): Fix xref. 2018-12-17 17:46:48 -05: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