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

2210 commits

Author SHA1 Message Date
Eli Zaretskii
bba8c532fa Update documentation of 'completion-table-dynamic'
* doc/lispref/minibuf.texi (Programmed Completion): Document the
new optional argument to 'completion-table-dynamic'.
2016-01-12 21:10:09 +02:00
Eli Zaretskii
e879070d8c Document changes in 'read-buffer' and 'read-buffer-function'
* doc/lispref/minibuf.texi (High-Level Completion): Document the
4th argument to 'read-buffer' and 'read-buffer-function'.
2016-01-12 21:00:19 +02:00
Eli Zaretskii
6ad0d39680 Update documentation of 'indirect-function'
* doc/lispref/eval.texi (Function Indirection): Update the
documentation of 'indirect-function'.
2016-01-10 20:22:01 +02:00
Eli Zaretskii
303141ae6e Update documentation for obsoleting 'syntax-begin-function'
* doc/lispref/syntax.texi (Position Parse): Undocument
'syntax-begin-function' that is now obsolete.
2016-01-10 20:05:46 +02:00
Stefan Monnier
b131fb8558 * loading.texi: Add `define-type' entry for load-history
* doc/lispref/loading.texi (Where Defined): Remove incorrect
cl-defmethod description, and add missing define-type entry.
2016-01-09 12:50:10 -05:00
Eli Zaretskii
9dfcbf0262 Update 'load-history' docs
* doc/lispref/loading.texi (Where Defined): Update the list of
forms in 'load-history' by adding the forms created for the
'cl-generic' generics.  (Bug#21422)
2016-01-09 10:55:35 +02:00
Eli Zaretskii
4b37cba3d5 Improve documentation of Delete Selection mode
* lisp/delsel.el (delete-selection-mode)
(delete-selection-helper): Update and expand the doc strings.
(Bug#22296)

* doc/emacs/mark.texi (Using Region): Document the behavior of
delete commands in Delete Selection mode.  (Bug#22296)

* doc/lispref/markers.texi (The Mark): Document how to add the
support for Delete Selection mode to Lisp programs. (Bug#22296)
2016-01-08 14:06:13 +02:00
Eli Zaretskii
c632466284 Obey coding-system-for-write when writing stdout/stderr in batch
* src/print.c (printchar_to_stream):
* src/xdisp.c (message_to_stderr): If coding-system-for-write has
a non-nil value, use it to encode output in preference to
locale-coding-system.  See the discussions in
http://lists.gnu.org/archive/html/emacs-devel/2016-01/msg00048.html
for the details.

* doc/lispref/os.texi (Terminal Output): Document how to send
non-ASCII text via 'send-string-to-terminal'.
(Batch Mode): Document how text written to standard streams is
encoded.  Fix inaccuracy regarding which output streams are used
by output functions in batch mode.
2016-01-06 20:25:45 +02:00
Paul Eggert
9c3dbabee3 Fix copyright years by hand
These are dates that admin/update-copyright did not update, or
updated incorrectly.
2016-01-01 01:38:07 -08:00
Paul Eggert
0e963201d0 Update copyright year to 2016
Run admin/update-copyright.
2016-01-01 01:34:24 -08:00
Eli Zaretskii
7c83d84619 Clarify docs of hscroll in RTL text
* doc/lispref/windows.texi (Horizontal Scrolling): Clarify the
meaning of a window's horizontal scroll amount for RTL paragraphs.
2015-12-30 19:13:44 +02:00
Alan Mackenzie
326ffcce5f Allow line comments ending with escaped NL to be continued to the next line.
Use this in C, C++, and Objective C Modes.  Fixes bug#22246

* src/syntax.c (comment-end-can-be-escaped): New buffer local variable.
(forw-comment, back-comment): On encountering an end of comment character,
test whether it is escaped when `comment-end-can-be-escaped' is non-nil.

* doc/lispref/syntax.texi (Control Parsing): Describe
`comment-end-can-be-escaped'.

* etc/NEWS (Lisp Changes): Describe `comment-end-can-be-escaped'.

* lisp/progmodes/cc-langs.el: New c-lang-setvar `comment-end-can-be-escaped'.
2015-12-28 16:01:05 +00:00
Eli Zaretskii
68218d8264 Document default process sentinel more prominently
* doc/lispref/processes.texi (Asynchronous Processes): Mention the
defaults for process filter and sentinel.  Provide cross-references.
(Process Information): Provide cross-references to where filters
and sentinels are described.
(Filter Functions): Add an index entry for "default filter".
(Sentinels): Add a few status messages not documented previously.
Resolve the "killed" confusion.  Document and describe the default
sentinel.  (Bug#22220)
2015-12-23 20:06:28 +02:00
Alan Mackenzie
df32db2f5f Merge branch 'scratch/follow' into emacs-25
This allows Isearch, etc., to work well when Follow Mode is active.
2015-12-20 12:33:30 +00:00
Eli Zaretskii
277d7efd24 Document new features of Font Lock
* doc/lispref/modes.texi (Other Font Lock Variables): Document
'font-lock-flush-function' and 'font-lock-ensure-function'.
(Font Lock Basics): Document the basic fontification functions
referenced in "Other Font Lock Variables".

* lisp/font-lock.el (font-lock-flush, font-lock-ensure): Doc fix.
2015-12-19 16:14:11 +02:00
Eli Zaretskii
d59abe74ac Manual followup to last change
* doc/lispref/display.texi (Displaying Messages): Sync with the
doc string.  (Bug#22210)
2015-12-19 14:19:12 +02:00
Eli Zaretskii
54d67d6f6f * doc/lispref/elisp.texi (Top): Update top-level menus. 2015-12-19 13:04:36 +02:00
Alan Mackenzie
a72a9fbbbc Rename recenter-group' to recenter-window-group'
* doc/lispref/windows.texi (Textual Scrolling)
* lisp/window.el (top level, recenter-group)
* lisp/follow.el (follow-mode)
* lisp/isearch.el (isearch-back-into-window): Rename `recenter-group' to
`recenter-window-group' and `recenter-group-function' to
`recenter-window-group-function'.
2015-12-18 10:40:49 +00:00
Alan Mackenzie
64ad54734d Tidy up documentation associated with window groups.
* doc/lispref/windows.texi (Basic Windows): Add an @anchor for "Window
Groups".  Correct example function to `window-group-start'.
(Window Start and End, Textual scrolling): Point to the new anchor.  State
that (most of) the args in window group functions have the same meaning as for
the corresponding window primitives.

* doc/lispref/positions.texi (Screen Lines).  Same as above.
2015-12-15 11:41:54 +00:00
Alan Mackenzie
e8937de554 Replace GROUP argument in six window primitives by new functions.
* doc/lispref/windows.texi (Window Start and End, Textual Scrolling)
* doc/lispref/positions.texi (Screen Lines): Remove optional GROUP argument
from description of six window functions.  Add in description of new functions
window-group-start, window-group-end, set-window-group-start,
pos-visible-in-window-group-p, recenter-group and move-to-window-group-line,
together with the six variables indirecting to the pertinent group
functions.

* src/window.c
* src/keyboard.c: Revert the commit from 2015-11-11 12:02:48, in so far as it
applies to these two files, which added the GROUP argument to six window
primitives.

* lisp/follow.el (follow-mode): Use updated variable names for the indirected
functions.

* lisp/isearch.el (isearch-update, isearch-done, isearch-string-out-of-window)
(isearch-back-into-window, isearch-lazy-highlight-new-loop)
(isearch-lazy-highlight-search, isearch-lazy-highlight-update): Replace calls
to window primitives (e.g. window-start) with a GROUP argument by calls to
new functions (e.g. window-group-start).

* lisp/ispell.el (ispell-command-loop): Replace call to
pos-visible-in-window-p with pos-visible-in-window-group-p.

* lisp/window.el (window-group-start, window-group-end)
(set-window-group-start, recenter-group, pos-visible-in-window-group-p)
(selected-window-group, move-to-window-group-line): New functions.
(window-group-start-function, window-group-end-function)
(set-window-group-start-function, recenter-group-function)
(pos-visible-in-window-group-p-function, selected-window-group-function)
(move-to-window-group-line-function): New variables.
2015-12-14 16:38:07 +00:00
Martin Rudalics
06f00d39ff Fix frame height calculations with added menu bar on Windows (Bug#22105)
* doc/lispref/frames.texi (Parameter Access): Mention pitfalls
when simultaneously specifying multiple parameters for
`modify-frame-parameters' that all may change the frame's size.
* src/w32fns.c (x_set_menu_bar_lines): Don't set
windows_or_buffers_changed here.
(my_create_tip_window, Fx_show_tip): Call AdjustWindowRect
with third argument false.
* src/w32menu.c (set_frame_menubar): Set
windows_or_buffers_changed here.
* src/w32term.c (x_set_window_size): Determine third argument of
AdjustWindowRect from whether the frame has a menu bar and not
from whether it wants one.
2015-12-12 14:38:11 +01:00
Eli Zaretskii
5cc4f33b4a Document multi-mode indentation facilities
* doc/lispref/text.texi (Mode-Specific Indent): Document
'prog-indentation-context', 'prog-first-column', and 'prog-widen'.

* lisp/progmodes/prog-mode.el (prog-indentation-context)
(prog-widen): Doc fixes.
2015-12-12 12:53:35 +02:00
Eli Zaretskii
1db9d8bd0f Clarify documentation of 'modify-frame-parameters'
* doc/lispref/frames.texi (Parameter Access): Clarify what "ignored
PARMs" mean for 'modify-frame-parameters'.

* src/frame.c (Fmodify_frame_parameters): Clarify what "ignored
PARMs" mean for this function.  (Bug#22104)
2015-12-11 10:46:18 +02:00
Eli Zaretskii
f7f4ea9f6b Clarify documentation of 'values'
* doc/lispref/eval.texi (Eval): Clarify that 'values' are not
updated by any evaluation commands in 'lisp-interaction-mode'.
(Bug#22056)
2015-12-11 10:20:16 +02:00
Eli Zaretskii
86130adf1e Improve documentation of kill commands
* lisp/simple.el (region-extract-function, delete-backward-char)
(delete-forward-char, kill-region, copy-region-as-kill)
(kill-ring-save): Better document the optional argument REGION in
the doc strings.  Mention in the doc strings that text put in the
kill-ring can be filtered by 'filter-buffer-substring'.

* doc/lispref/text.texi (Kill Functions): Mention that functions
described in this subsection can filter text they put in the
kill-ring.  Add a cross-reference to "Buffer Contents" and an
index entry.  Document the optional argument 'region' and its
effect.
(Bug#21315)
2015-12-07 18:20:43 +02:00
Alan Mackenzie
f5c403d269 Amend doc of `mapconcat': it can take sequences, not merely strings.
* doc/lispref/functions.texi (Mapping Functions): Amend the doc of `mapconcat'
to say that SEPARATOR and the results from FUNCTION may be any character
sequences, not just strings.  Add an @xref to "Sequences Arrays Vectors".
2015-12-07 10:39:07 +00:00
Eli Zaretskii
5278188285 Initial documentation of dynamic modules
* doc/lispref/loading.texi (Dynamic Modules): New section with
initial documentation for dynamic modules.
* doc/lispref/elisp.texi (Top): Add "Dynamic Modules" to the
detailed menu

* etc/NEWS: Fix typos in dynamic modules' entry.
2015-12-05 13:51:09 +02:00
Eli Zaretskii
b3b68eb655 Fix documentation of 'undo' changes
* doc/lispref/text.texi (Undo): Minor wording changes.  Use US
English conventions for spelling and whitespace between sentences.

* etc/NEWS: Fix wording and spelling of undo-related entries.
Mark them as documented.
2015-12-05 11:12:38 +02:00
Alan Mackenzie
64c5730365 First commit to scratch/follow. Make Isearch work with Follow Mode, etc.
doc/lispref/window.texi (Basic Windows): Add paragraph defining "Group of
Windows" and new @defun selected-window-group.
(Window Start and End): Describe new &optional parameter GROUP and
...-group-function for window-start, window-end, set-window-start, and
pos-visible-in-window-p.
(Textual Scrolling) Describe the same for recenter.
doc/lispref/positions.texi (Screen Lines): Describe the same for
move-to-window-line.

src/window.c (Fwindow_start, Fwindow_end, Fset_window_start)
(Fpos_visible_in_window_p, Frecenter, Fmove_to_window_line): To each, add ar
new optional parameter "group".  At the beginning of each, check whether the
corresponding ...-group-function is set to a function, and if so execute this
function in place of the normal processing.
(syms_of_window): Define symbols for the six new variables below.
(window-start-group-function, window-end-group-function)
(set-window-start-group-function, recenter-group-function)
(pos-visible-in-window-p-group-function, move-to-window-line-group-function):
New permanent local buffer local variables.
src/keyboard.c (Fposn_at_point): Add extra parameter in call to
Fpos_visible_in_window_p.

lisp/window.el (selected-window-group-function): New permanent local buffer
local variable.
(selected-window-group): New function.

lisp/follow.el (follow-mode): Set the ...-group-function variables at mode
enable, kill them at mode disable.  Add/remove follow-after-change to/from
after-change-functions.
(follow-start-end-invalid): New variable.
(follow-redisplay): Manipulate follow-start-end-invalid.
(follow-after-change, follow-window-start, follow-window-end)
(follow-set-window-start, follow-pos-visible-in-window-p)
(follow-move-to-window-line, follow-sit-for): New functions.

lisp/isearch.el (isearch-call-message): New macro.
(isearch-update, with-isearch-suspended, isearch-del-char)
(isearch-search-and-update, isearch-ring-adjust): Invoke above new macro.
(with-isearch-suspended): Rearrange code such that isearch-call-message is
invoked before point is moved.
(isearch-message): Add comment about where point must be at function call.
(isearch-search): Remove call to isearch-message.
(isearch-lazy-highlight-window-group): New variable.
(isearch-lazy-highlight-new-loop): Unconditionally start idle timer.  Move
the battery of tests to ...
(isearch-lazy-highlight-maybe-new-loop): New function, started by idle timer.
Note: (sit-for 0) is still called.
(isearch-lazy-highlight-update): Check membership of
isearch-lazy-highlight-window-group.  Don't set the `window' overlay
property.
(isearch-update, isearch-done, isearch-string-out-of-window)
(isearch-back-into-window, isearch-lazy-highlight-maybe-new-loop)
(isearch-lazy-highlight-search, isearch-lazy-highlight-update)
(isearch-lazy-highlight-update): Call the six amended primitives (see
src/window.c above) with the new `group' argument set to t, to cooperate
with Follow Mode.
2015-12-04 18:15:27 +00:00
Phillip Lord
eaa1fd6dbf Externalize some symbols in undo-auto
* doc/lispref/text.texi: Update symbols.
 * lisp/simple.el (undo-auto--amalgamate,
   undo-auto--current-boundary-timer): Make symbols public.
 * src/cmds.c (Fself_insert_command,Fdelete_char): Call
   updated symbol.
2015-12-03 21:27:33 +00:00
Eli Zaretskii
0cec548152 Document 'nacl' value for 'system-type'
* doc/lispref/os.texi (System Environment): Document the 'nacl'
value of 'system-type'.
2015-12-03 18:36:03 +02:00
Eli Zaretskii
e011b22d20 Document 'window-max-chars-per-line'
* doc/lispref/windows.texi (Window Sizes): Document
'window-max-chars-per-line'.
2015-12-03 18:26:39 +02:00
Eli Zaretskii
44d6957767 Document new font-related functionality
* doc/lispref/display.texi (Low-Level Font): Document
'default-font-width', 'default-font-height', 'window-font-width',
and 'window-font-height'.

* etc/NEWS: Move entries for 'default-font-width',
'default-font-height', 'window-font-width', and 'window-font-height'
to their place and mark them documented.
2015-12-03 18:03:47 +02:00
Eli Zaretskii
eca277f937 Fix documentation and implementation of 'directory-name-p'
* lisp/files.el (directory-name-p): Modify to recognize
backslashes on MS-Windows and MS-DOS.  Adjust the doc string
accordingly.  Use '=', not char-equal, for comparison, as
letter-case cannot possibly be an issue here.

* doc/lispref/files.texi (Directory Names): Move the documentation
of directory-name-p here from "Relative File Names".  Update the
description per the changes in implementation.

* etc/NEWS: Move the entry for 'directory-name-p' to its proper
place and mark it documented.
2015-12-03 16:59:42 +02:00
Eli Zaretskii
b99a34bcb0 Document 'directory-files-recursively'
* lisp/files.el (directory-files-recursively): Doc fix.  Rename
the argument MATCH to REGEXP, to be more explicit about its form.

* doc/lispref/files.texi (Contents of Directories): Improve the
documentation of 'directory-files-recursively'.  Add
cross-references.

* etc/NEWS: Move the entry for 'directory-files-recursively' to
its place and mark it documented.
2015-12-01 18:16:22 +02:00
Eli Zaretskii
e702ab8d84 Document 'inhibit-read-only' property
* doc/lispref/text.texi (Special Properties): Describe the new
'inhibit-read-only' text property.  Add cross-reference to where
read-only buffers are described.
* doc/lispref/buffers.texi (Read Only Buffers): Mention that
'inhibit-read-only' property exempts text from being read-only.
Add cross-reference to "Special Properties".

* etc/NEWS: Move the entry about 'inhibit-read-only' property to
its place and mark it documented.
2015-12-01 18:11:11 +02:00
Phillip Lord
f227655b2d ; Fix broken reference
* doc/lispref/test.texi: Fix cross-reference.
2015-11-30 20:19:24 +00:00
Phillip Lord
c2ba4a20aa ; Added documentation for undo-auto functionality.
* doc/lispref/text.texi: Documentation added
 * etc/NEWS: Annoucement added
 * lisp/simple.el (undo-auto--amalgamate): Docstring fix.
2015-11-30 20:14:13 +00:00
Paul Eggert
1564a265b9 Fix font typo in previous doc fix. 2015-11-30 09:00:25 -08:00
Paul Eggert
f0067611f1 A bit more security doc, esp. file local vars
* doc/emacs/emacs.texi (Top):
* doc/emacs/misc.texi (Miscellaneous Commands):
Refer to new Host Security section.
(Host Security): New section.
* doc/lispref/os.texi (Security Considerations):
Mention file local variables.
2015-11-30 08:57:22 -08:00
Eli Zaretskii
36255fba58 Improve documentation of string-collate-* functions
* doc/lispref/strings.texi (Text Comparison): Improve wording and
indexing of 'string-collate-equalp' and 'string-collate-lessp'.

* etc/NEWS: Move the entry of 'string-collate-equalp' and
'string-collate-lessp' to "Lisp Changes" section and mark it as
documented.
2015-11-29 19:52:16 +02:00
Eli Zaretskii
f3bd8262a2 Document truncate-string-ellipsis
* doc/lispref/display.texi (Size of Displayed Text): Document
'truncate-string-ellipsis'.

* lisp/international/mule-util.el (truncate-string-ellipsis): Doc fix.
(truncate-string-to-width): Mention in the doc string that the
default for ELLIPSIS comes from 'truncate-string-ellipsis'.

* etc/NEWS: Move the 'truncate-string-ellipsis' entry to the "Lisp
Changes" section.
2015-11-29 19:40:08 +02:00
Eli Zaretskii
d4ade2c8fa Document new checkdoc features
* doc/lispref/tips.texi (Tips, Library Headers): Document the
keyword-checking features of checkdoc and the commands
'checkdoc-file' and 'checkdoc-current-buffer'.

* etc/NEWS: Move the checkdoc-related entries to their own
section.
2015-11-28 14:32:04 +02:00
Eli Zaretskii
3f42061bb6 Improve documentation of 'eval-buffer' and 'eval-region'
* src/lread.c (Feval_buffer, Feval_region): Doc fixes.  (Bug#22023)

* doc/lispref/eval.texi (Eval): Mention narrowing to clarify
"accessible portion of buffer".
2015-11-27 12:07:08 +02:00
Paul Eggert
b8bf031611 Improve text-quoting-style doc again
* doc/lispref/help.texi (Keys in Documentation):
Omit overkill discussion of ‘setq’.  Mention Emacs versions
where ‘grave’ style was standard.
2015-11-23 21:49:56 -08:00
Paul Eggert
946ea4184c Improve text-quoting-style doc 2015-11-23 19:23:06 -08:00
Martin Rudalics
3264a26dd2 * doc/lispref/windows.texi (Window Sizes): Fix indices and references. 2015-11-23 08:37:45 +01:00
Eli Zaretskii
3ca44a1ad4 Call 'window-size-change-functions' for mini-windows
* src/window.c (grow_mini_window, shrink_mini_window): Set the
frame's 'window_sizes_changed' flag.
* src/xdisp.c (redisplay_internal): Call the hooks on
'window-size-change-functions' if the call to 'echo_area_display'
sets the frame's 'window_sizes_changed' flag.
(syms_of_xdisp) <window-size-change-functions>:
Update doc string to indicate the mini-window resizes trigger a
call to the hooks, and don't promise that will happen "before
redisplay".  (Bug#19576, Bug#21333)

* doc/lispref/windows.texi (Window Hooks): Update the description
of 'window-size-change-functions'.
2015-11-21 13:30:30 +02:00
John Wiegley
eb3f6754b4 Correct a documentation error in frames.texi 2015-11-20 11:24:21 -08:00
Eli Zaretskii
07742820e4 Document that GNU Make >= 3.81 is required to build Emacs
* doc/lispref/internals.texi (Building Emacs): Document that GNU
Make 3.81 or later is now required.
2015-11-14 18:12:25 +02:00