1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2026-03-09 00:11:49 -07:00
Commit graph

2170 commits

Author SHA1 Message Date
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
Eli Zaretskii
34530571fc Remove support for ':timeout' from w32 tray notifications
* src/w32fns.c (Fw32_notification_notify): Delete the code that
supports ':timeout'.
(syms_of_w32fns): Don't DEFSYM ':timeout'.  This avoids clashes
with dbusbind.c when D-Bus is compiled in.

* doc/lispref/os.texi (Desktop Notifications): Don't mention
':timeout'.

Backport.
2015-11-13 22:01:26 +02:00
Juanma Barranquero
e887f6e33b ; * doc/lispref/os.texi: Fix indentation of sample code. 2015-11-11 18:43:48 +01:00
Nicolas Petton
51d840a8a1 Rename seq-p and map-p to seqp and mapp
* lisp/emacs-lisp/seq.el (seqp): New name.
* lisp/emacs-lisp/map.el (mapp): New name.
* doc/lispref/sequences.texi: Update the documentation for seqp.
* test/automated/map-tests.el: Update the tests for mapp.
2015-11-11 18:20:03 +01:00
Eli Zaretskii
9d43941569 Implement tray notifications for MS-Windows
* src/w32fns.c (MY_NOTIFYICONDATAW): New typedef.
(NOTIFYICONDATAW_V1_SIZE, NOTIFYICONDATAW_V2_SIZE)
(NOTIFYICONDATAW_V3_SIZE, NIF_INFO, NIIF_NONE, NIIF_INFO)
(NIIF_WARNING, NIIF_ERROR, EMACS_TRAY_NOTIFICATION_ID)
(EMACS_NOTIFICATION_MSG): New macros.
(NI_Severity): New enumeration.
(get_dll_version, utf8_mbslen_lim, add_tray_notification)
(delete_tray_notification, Fw32_notification_notify)
(Fw32_notification_close): New functions.
(syms_of_w32fns): Defsubr functions exposed to Lisp.  DEFSYM
keywords used by w32-notification-notify.

* doc/lispref/os.texi (Desktop Notifications): Describe the native
w32 tray notifications.
2015-11-11 18:29:36 +02:00
Paul Eggert
c92dbd6d0c Spelling fixes
* lisp/net/soap-inspect.el (soap-inspect-xs-simple-type):
Fix misspelling in output.
2015-11-10 10:23:00 -08:00
Artur Malabarba
d149ca81c3 * doc/lispref/variables.texi (Directory Local Variables):
Document dir-locals wildcards

* lisp/files.el (dir-locals-file): Point to Info node.

* doc/emacs/custom.texi (Directory Variables):
Document dir-locals wildcards.

* etc/NEWS: Document new functionality.
2015-11-10 14:45:50 +00:00
Martin Rudalics
07178f43e1 * doc/lispref/windows.texi (Coordinates and Windows): Fix typo. 2015-11-07 09:19:03 +01:00
Ken Brown
a9cdc4a23c Document behavior of collation on Cygwin
* test/automated/fns-tests.el (fns-tests-collate-sort): Mark as
expected failure on Cygwin.
* doc/lispref/strings.texi (Text Comparison): Document that
punctuation and whitespace are not ignored for sorting on Cygwin.
2015-11-02 11:22:51 -05:00
Eli Zaretskii
8e8a06803c ; Improve documentation of 'unhandled-file-name-directory'
* doc/lispref/files.texi (Magic File Names): Better wording for the
last change in the documentation of 'unhandled-file-name-directory'.
2015-10-29 19:48:18 +02:00
Dmitry Gutov
ffa41ad2a0 Don't require default-directory to end with a slash
* doc/lispref/files.texi (Magic File Names): Document the change
in unhandled-file-name-directory.

* lisp/url/url-handlers.el
(url-handler-unhandled-file-name-directory): Update accordingly.

* src/buffer.c (default-directory): Update the docsting.

* src/fileio.c (unhandled-file-name-directory): Default to calling
`file-name-as-directory'
(http://lists.gnu.org/archive/html/emacs-devel/2015-10/msg02294.html).
2015-10-29 03:01:45 +02:00
Artur Malabarba
785c0d8326 * doc/lispref/sequences.texi (Sequence Functions): Fix typo 2015-10-28 17:06:27 +00:00
Artur Malabarba
7dfe247864 * lisp/emacs-lisp/seq.el (seq-mapn): New function
* doc/lispref/sequences.texi (Sequence Functions): Document seq-mapn
2015-10-28 15:40:23 +00:00
Stephen Leake
93dba9c2d7 Clarify that load-path contents should be directory file names
* doc/lispref/files.texi (Directory Names): Define and use "directory
file name". Recommend `expand-file-name'.

* src/lread.c (load-path): Fix doc string; elements are directory file
names.
2015-10-26 14:40:34 -05:00
Michael Albinus
0d9c67236c Further work on `stopped' events in filenotify.el
* doc/lispref/os.texi (File Notifications): Rework examples.

* lisp/filenotify.el (file-notify--rm-descriptor): Optional parameter.
(file-notify--rm-descriptor, file-notify-callback): Improve check
for sending `stopped' event.
(file-notify-add-watch): Check for more events for `inotify'.

* test/automated/file-notify-tests.el
(file-notify--test-expected-events): New defvar.
(file-notify--test-with-events): Use it.
(file-notify--test-cleanup): Make it more robust when deleting
directories.
(file-notify--test-event-test): Check also for watched directories.
(file-notify--test-event-handler): Suppress temporary .#files.
(file-notify-test02-events, file-notify-test04-file-validity):
Rework `stopped' events.
(file-notify-test05-dir-validity): Wait for events when appropriate.
2015-10-26 16:46:48 +01:00
Michael Albinus
80dd76a8e5 Document file notification `stopped' event
* doc/lispref/os.texi (File Notifications): Document `stopped event'.
2015-10-25 14:59:45 +01:00
Paul Eggert
f373e812d9 New lispref section “Security Considerations”
This attempts to document some of the issues recently discussed
on emacs-devel, and to indicate other such issues.  The section
could be a lot longer.
* doc/lispref/os.texi (Security Considerations):
New node.
* doc/lispref/elisp.texi (Top):
* doc/lispref/processes.texi (Shell Arguments):
* lisp/subr.el (shell-quote-argument):
* src/callproc.c (syms_of_callproc):
Reference it.
2015-10-21 20:26:49 -07:00
Paul Eggert
e9af822ac3 (/ N) now returns the reciprocal of N
This is more compatible with Common Lisp and XEmacs (Bug#21690).  See:
http://lists.gnu.org/archive/html/emacs-devel/2015-10/msg01053.html
* lisp/color.el (color-hue-to-rgb, color-hsl-to-rgb)
(color-xyz-to-srgb, color-xyz-to-lab):
* lisp/emacs-lisp/cl-extra.el (cl-float-limits):
* lisp/net/shr-color.el (shr-color-hue-to-rgb)
(shr-color-hsl-to-rgb-fractions):
Exploit the change to simplify the code a bit.
* lisp/emacs-lisp/bytecomp.el (byte-compile-quo):
Don’t complain about single-argument calls to ‘/’.
* src/data.c (arith_driver, float_arith_driver):
Implement the change.
2015-10-20 18:22:48 -07:00
Nicolas Petton
04d604e055 New function seq-position
* lisp/emacs-lisp/seq.el (seq-position): New function.
* test/automated/seq-tests.el: New tests for seq-position.
* doc/lispref/sequences.texi: Add documentation for `seq-position'.
2015-10-20 00:39:27 +02:00
Eli Zaretskii
f1575763c0 Fix return value of 'set-file-extended-attributes'
* lisp/files.el (set-file-extended-attributes): Return non-nil
when setting either ACLs or SELinux context succeeds.  Document
the return value.  (Bug#21699)

* doc/lispref/files.texi (Changing Files): Document the return
value of set-file-extended-attributes.
2015-10-19 10:04:50 +03:00
Eli Zaretskii
552482d41d ; * doc/lispref/processes.texi (Synchronous Processes): Minor copyedit. 2015-10-19 09:12:51 +03:00
Eli Zaretskii
bca2bc4fe9 Improve documentation of functions that change files
* doc/lispref/files.texi (Changing Files): Document that these
functions signal an error on failure.
2015-10-19 08:31:58 +03:00
Eli Zaretskii
b0d190fbe2 Minor improvement in documentation of internals
* doc/lispref/internals.texi (Writing Emacs Primitives): Document QUIT.
2015-10-16 13:01:53 +03:00
Eli Zaretskii
d05410f349 Improve documentation of COLLECTION in completion functions
* doc/lispref/minibuf.texi (Minibuffer Completion): Add a
cross-reference to "Programmed Completion".

* src/minibuf.c (Fcompleting_read): Improve the doc string.
(Bug#21644)
2015-10-16 12:38:36 +03:00
Paul Eggert
29dfca2355 Use ‘echo’ safely with ‘\’ or leading ‘-’
POSIX says that ‘echo FOO’ produces implementation-defined output
if FOO contains leading ‘-’, or ‘\’ anywhere, so don’t assume GNU
behavior in that case.
* Makefile.in (removenullpaths): Remove.
(epaths-force): Rewrite to avoid the need for ‘echo’.
(install-etc): Be clearer about escaping the shell metacharacters
‘\’ and ‘$’.
* Makefile.in (install-arch-indep, install-etcdoc):
* admin/charsets/mapconv, admin/merge-gnulib, admin/merge-pkg-config:
* admin/quick-install-emacs, build-aux/gitlog-to-emacslog:
* configure.ac, lib-src/rcs2log, make-dist:
* src/Makefile.in (lisp.mk):
Don’t assume ‘echo’ outputs ‘\’ and leading ‘-’ unscathed.
For example, use ‘printf '%s\n' "$foo"’ rather than ‘echo "$foo"’
if $foo can contain arbitrary characters.
* lisp/Makefile.in (TAGS): Use ‘ls’, not ‘echo’, to avoid ‘\’ issues.
* doc/lispref/two-volume.make (vol1.pdf):
* test/etags/make-src/Makefile (web ftp publish):
Use ‘printf’ rather than ‘echo -e’.
2015-10-10 18:11:27 -07:00
Xue Fuqiao
25b4572073 * doc/lispref/objects.texi (Window Type): Add a cross reference. 2015-10-06 10:52:28 +08:00
Xue Fuqiao
9cca3fe8ba Doc fix for `defmacro'
* doc/lispref/objects.texi (Macro Type): `defmacro' is a macro now.
2015-10-03 21:24:09 +08:00
Paul Eggert
dd6346e00c Fix a few problems with directed quotes
This is in response to a problem report by Kaushal Modi in:
http://bugs.gnu.org/21588#25
* lisp/cedet/mode-local.el (describe-mode-local-overload):
* lisp/emacs-lisp/bytecomp.el (byte-compile-fix-header):
* lisp/info-xref.el (info-xref-check-all-custom):
* lisp/mail/emacsbug.el (report-emacs-bug-hook):
Prefer directed to undirected single quotes in diagnostics.
2015-10-01 21:44:35 -07:00
Eli Zaretskii
1c6a58705b ; Clarify docs of pos-visible-in-window-p some more 2015-09-30 12:46:17 +03:00
Eli Zaretskii
47089e0cc8 Clarify documentation of pos-visible-in-window-p
* src/window.c (Fpos_visible_in_window_p): Clarify the meaning of
t for POS.  See
http://lists.gnu.org/archive/html/emacs-devel/2015-09/msg01040.html
for the original report.

* doc/lispref/windows.texi (Window Start and End): Clarify the
meaning of t for the POSITION argument of pos-visible-in-window-p.
2015-09-30 10:19:41 +03:00
Nicolas Petton
f6e1f158f0 Add documentation for seq.el
* doc/lispref/sequences.texi: Add documentation regarding extending
seq.el, as well as missing documentation for seq-elt, seq-length, seq-p,
seq-do and seq-map.
2015-09-28 22:18:26 +02:00
Nicolas Petton
f0b71429b9 Better documentation for seq-some
* doc/lispref/sequences.texi:
* lisp/emacs-lisp/seq.el: Update the documentation of seq-some to
guarantee that the returned value is the first non-nil value that
resulted from applying the predicate.
2015-09-28 21:15:58 +02:00
Alan Mackenzie
feddb99afd Resurrect edebug-set-initial-mode, repurposing it to set the global mode.
lisp/emacs-lisp/edebug.el (edebug-initial-mode-alist): Uncomment, and
amend to match current modes and functions.
(edebug-set-initial-mode): Uncomment and change from setting a defun's
`edebug-initial-mode''s property to setting the variable
`edebug-initial-mode'.
(top level): Create new binding C-x C-a C-m for
`edebug-set-initial-mode'.

doc/lispref/edebug.texi (Edebug Execution Modes): document
`edebug-set-initial-mode' and its new key binding.
(Edebug Options): Mention the new command in the pertinent place.

etc/NEWS: Write entry for this change.
2015-09-25 11:31:50 +00:00
Eli Zaretskii
0d31eeb796 Avoid non-ASCII decoding errors in Texinfo files
* doc/misc/tramp.texi:
* doc/lispref/strings.texi:
* doc/lispref/positions.texi:
* doc/lispref/help.texi:
* doc/lispref/functions.texi:
* doc/lispintro/emacs-lisp-intro.texi:
* doc/emacs/text.texi:
* doc/emacs/modes.texi:
* doc/emacs/mini.texi:
* doc/emacs/display.texi:
* doc/emacs/custom.texi:
* doc/emacs/basic.texi: Add 'coding' cookies -- these files use
Unicode characters and should be decoded as UTF-8.
* doc/lispref/frames.texi (Size Parameters): Don't use a non-ASCII
apostrophe unnecessarily.
2015-09-25 12:32:13 +03:00
Eli Zaretskii
aab67529d2 Support ':relative-width' space display spec on text-mode terminals
* src/xdisp.c (produce_stretch_glyph): Support ':relative-width'
space display spec on text-mode terminals, by calling
PRODUCE_GLYPHS instead of x_produce_glyphs.  Remove the HAVE_WINDOW_SYSTEM
guards from the supporting code, as well as the test for a GUI frame.
2015-09-23 16:20:10 +03:00
Eli Zaretskii
a4d5717e7b Clarify documentation of ':relative-width'
* doc/lispref/display.texi (Specified Space): Document that
':relative-width' is only supported on GUI frames.
2015-09-22 19:51:47 +03:00
Alan Mackenzie
2fa2c87cac Make description of `edebug-initial-mode' user friendly.
Fixes debbugs#21365.

dec/lispref/edebug.texi (Edebug Execution Modes): Change the
desscription
of `edebug-initial-mode' from that of its implementation to that of its
visual effect and use.  Move the paragraph higher up.
2015-09-22 12:45:00 +00:00
Eli Zaretskii
948059e564 ; * doc/lispref/os.texi (File Notifications): Minor copy-edits. 2015-09-22 13:08:02 +03:00
Paul Eggert
818fc6e128 Clarify or replace a few \u escapes.
* doc/lispref/nonascii.texi (Character Properties)
More-detailed commentary for \u escapes.
* lisp/progmodes/python.el (python--prettify-symbols-alist):
* lisp/replace.el (query-replace-from-to-separator):
* lisp/textmodes/rst.el (rst-bullets, rst-re-alist-def)
(rst-mode-syntax-table):
* lisp/whitespace.el (whitespace-display-mappings):
Prefer actual character to \u escape when this makes the code
easier to follow in the usual case where Unicode chars can be
displayed.
2015-09-21 07:59:16 -07:00
Michael Albinus
01b547529b Adapt tests and manual for w32notify
* doc/lispref/os.texi (File Notifications): w32notify does not
send `attribute-changed' events.

* test/automated/file-notify-tests.el (file-notify--test-with-events):
Simplify parameters.  Adapt all callees.
(file-notify-test02-events): w32notify does not send
`attribute-changed' events.
(file-notify-test04-file-validity, file-notify-test05-dir-validity):
Do not skip in case of w32notify.  Simply ignore this part of the test.
2015-09-21 15:07:06 +02:00
Nicolas Petton
0a893f0cfa Better docstring and parameter name for seq-find
* lisp/emacs-lisp/seq.el (seq-find): Improve the docstring and rename
the parameter `sentinel' to `default'.

* doc/lispref/sequences.texi (Sequence Functions): Update the
  documentation for `seq-find' accordingly.
2015-09-21 11:48:55 +02:00