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

6222 commits

Author SHA1 Message Date
Tino Calancha
d670a15f25 * doc/misc/url.texi (http/https): Fix typo 2017-11-29 11:42:11 +09:00
Kaushal Modi
0540df10e6 Update documentation of '.dir-locals-2.el'
See https://lists.gnu.org/r/emacs-devel/2017-11/msg00649.html
for more details.
* lisp/files.el (dir-locals-file-2): Remove unused constant.
* lisp/files.el (dir-locals-file): Mention ".dir-locals-2.el" in
the doc string.
* doc/lispref/variables.texi (Directory Local Variables): Mention
".dir-locals-2.el".
* etc/NEWS: Replace `dir-locals-file-2' mention with
`dir-locals-file'.
2017-11-28 19:17:48 +02:00
Eli Zaretskii
0a85d12474 Fix ELisp "Warning Tips"
* doc/lispref/tips.texi (Warning Tips): Clarify when to use
'require' wrapped by 'eval-when-compile'.  (Bug#29462)
2017-11-27 18:24:29 +02:00
Eli Zaretskii
16358d4fcb Improve documentation of "constant" symbols
* src/font.c (syms_of_font) <font-weight-table, font-slant-table>
<font-width-table>:
* src/data.c (syms_of_data) <most-positive-fixnum>
<most-negative-fixnum>:
* src/buffer.c (syms_of_buffer) <enable-multibyte-characters>:
Mention in the doc strings that these variables are read-only.

* doc/lispref/variables.texi (Creating Buffer-Local): Document
that making a constant variable buffer-local signals an error.
* doc/lispref/variables.texi (Constant Variables):
* doc/lispref/errors.texi (Standard Errors): More accurate and
up-to-date documentation of which symbols cannot be assigned
values.
2017-11-26 20:23:15 +02:00
Paul Eggert
a89f0b6f33 maint: shorten https://lists.gnu.org/archive/html/... links 2017-11-25 22:48:12 -08:00
Paul Eggert
8be3aee281 Merge from Gnulib
This incorporates:
2017-11-23 stat: work around Solaris bug with tv_nsec < 0
2017-11-12 maint: shorten https://lists.gnu.org/archive/html/... links
* build-aux/config.sub, doc/misc/texinfo.tex, lib/allocator.h:
* lib/fstatat.c, lib/intprops.h, lib/lstat.c, lib/signal.in.h:
* lib/stat-time.h, lib/stdio-impl.h, lib/stdio.in.h:
* lib/timespec.h, m4/alloca.m4, m4/extern-inline.m4:
* m4/faccessat.m4, m4/fstatat.m4, m4/gnulib-common.m4:
* m4/lstat.m4, m4/std-gnu11.m4, m4/sys_types_h.m4:
* m4/vararrays.m4:
Copy from Gnulib.
2017-11-25 22:48:09 -08:00
Eli Zaretskii
b4f67ebb92 Improve discoverability of 'defvar' for suppressing warnings
* doc/lispref/compile.texi (Compiler Errors): Add index entries.
* doc/lispref/variables.texi (Defining Variables): Mention that
defvar with no value is used for suppressing compiler warnings.
(Bug#29400)
2017-11-24 16:36:33 +02:00
Eli Zaretskii
8a2b204e64 Improve discoverability of 'read-buffer-completion-ignore-case'
* lisp/window.el (switch-to-buffer)
(switch-to-buffer-other-window, switch-to-buffer-other-frame):
Mention 'read-buffer' in the doc string.  (Bug#29389)

* doc/emacs/buffers.texi (Select Buffer): Add a cross-reference to
where 'read-buffer-completion-ignore-case' is documented.
2017-11-24 15:58:00 +02:00
Eli Zaretskii
eea4e9194c Improve documentation of self-insert-uses-region-functions
* lisp/simple.el (self-insert-uses-region-functions): Clarify the
doc string.
* lisp/delsel.el (delete-selection-uses-region-p): Mention
'self-insert-command' in the doc string.  (Bug#29373)

* doc/lispref/text.texi (Commands for Insertion): Mention
'self-insert-uses-region-functions'.
* doc/lispref/modes.texi (Keymaps and Minor Modes): Add a
cross-reference to "Commands for Insertion".
2017-11-24 12:49:04 +02:00
Eli Zaretskii
1d0dbdff6c Reorder type predicates in ELisp manual
* doc/lispref/objects.texi (Type Predicates): Restore alphabetical
order of listed predicates.  (Bug#29411)
2017-11-24 10:07:40 +02:00
Glenn Morris
8e40429c96 ; Fix some doc typos 2017-11-22 17:52:11 -05:00
Gemini Lasswell
93304e3115 Improve documentation of Edebug and macros
* doc/lispref/edebug.texi (Instrumenting Macro Calls): Improve
discussion of when it might be necessary to find and evaluate macro
specifications before instrumenting.
(Specification List): Clarify what "defining form" means to Edebug
and when 'def-form' or 'def-body' should be used instead of 'form'
or 'body'.
2017-11-13 13:22:39 -08:00
Paul Eggert
5d68dc9a2f Change vectorlike from struct to union
* src/lisp.h (vectorlike_headed): Change from struct to union.
All uses changed.  Since it has only one member, this does not
change semantics.  This is designed to simplify future changes
needed to fix bugs like Bug#29040.  All uses changed.
2017-11-13 10:16:51 -08:00
Paul Eggert
7775c47298 Merge from Gnulib
This incorporates:
2017-11-11 faccessat: port to macOS (Bug#29231)
2017-11-05 fstatat: pacify GCC on unusual platform
* build-aux/config.guess, build-aux/config.sub:
* doc/misc/texinfo.tex, lib/faccessat.c, lib/fstatat.c:
* lib/unistd.in.h, m4/faccessat.m4, m4/unistd_h.m4:
Copy from Gnulib.
* lib/gnulib.mk.in, m4/gnulib-comp.m4: Regenerate.
2017-11-11 23:12:17 -08:00
Eli Zaretskii
603a0716a8 Improve the documentation of M-n for entering file names
* lisp/files.el (find-file, find-file-other-window)
(find-file-other-frame): Mention file-name-at-point-functions in
the doc string.  Reported by Florian Weimer <fw@deneb.enyo.de> in
http://lists.gnu.org/archive/html/emacs-devel/2017-11/msg00224.html.

* doc/emacs/mini.texi (Minibuffer History): Document
file-name-at-point-functions and its effect on M-n when typing
file names in the minibuffer.
* doc/emacs/files.texi (File Names):
* doc/emacs/mini.texi (Minibuffer File): Add a cross-reference to
"Minibuffer History", where special features of M-n regarding
files are described.
2017-11-11 13:48:37 +02:00
Martin Rudalics
4a6015811e ; In text.texi fix typo spotted by Štěpán Němec 2017-11-06 14:11:15 +01:00
Martin Rudalics
93cd8415b2 Document new treatment of 'comment-auto-fill-only-comments'
* doc/lispref/text.texi (Auto Filling): Add reference to Emacs
manual.  Add description of 'comment-auto-fill-only-comments'.
* etc/NEWS: Mention new treatment of
'comment-auto-fill-only-comments'.
2017-11-06 08:45:52 +01:00
Michael Albinus
709478eaa8 Prefer `customize-set-variable' in tramp.texi
* doc/misc/tramp.texi (Configuration, Default Method, Default User)
(Default Host, Remote shell setup, Auto-save and Backup)
(Ad-hoc multi-hops, Frequently Asked Questions):
Prefer `customize-set-variable' over `custom-set-variables'.
2017-11-05 20:07:12 +01:00
Eli Zaretskii
c572e1f329 Return non-nil from gnutls-available-p under GnuTLS 2.x
* doc/misc/emacs-gnutls.texi (Help For Users): Update the
documentation of 'gnutls-available-p'.

* etc/NEWS (GnuTLS): Mention the change in the value returned by
'gnutls-available-p'.

* src/gnutls.c (Fgnutls_available_p): Return non-nil when GnuTLS
2.x is available.  (Bug#29147)
2017-11-05 17:26:36 +02:00
Charles A. Roelli
00fa4449cd ; Fix typo
* doc/misc/cc-mode.texi (Other Commands): Fix typo.
2017-11-05 10:18:00 +01:00
Eli Zaretskii
369da28702 Improve documentation of 'window-scroll-functions'
* doc/lispref/windows.texi (Window Hooks): Clarify the values of
arguments of 'window-scroll-functions' functions.

* src/xdisp.c (syms_of_xdisp) <window-scroll-functions>: Doc fix.
2017-11-04 18:09:01 +02:00
Eli Zaretskii
787b75ad71 Improve documentation of window hooks
* doc/lispref/windows.texi (Window Hooks): Fix the description of
window-configuration-change-hook.  (Bug#29049)
<run-window-scroll-functions, run-window-configuration-change-hook>:
Document these functions.
2017-11-04 11:56:26 +02:00
Alan Mackenzie
a0d30d6369 Introduce a function to CC Mode which displays the current function name
Remove an erroneous interactive specification from two functions.

* lisp/progmodes/cc-cmds.el (c-display-defun-name): New command.
(c-defun-name, c-cpp-define-name): Remove interactive specification.

* lisp/progmodes/cc-mode.el (c-mode-base-map): Add binding C-c C-z for the new
command.

* doc/misc/cc-mode.texi (Other Commands): Add documentation for the new
command.
2017-11-03 19:45:17 +00:00
João Távora
e950f329c0 New xref-quit-and-goto-xref command bound to TAB (bug#28814)
This is like xref-goto-xref, but quits the *xref* window just before
the user jump to ref.

* lisp/progmodes/xref.el (xref--show-location): Handle 'quit
value for SELECT.
(xref-goto-xref): Take optional QUIT arg.
(xref-quit-and-goto-xref): New command.
(xref--xref-buffer-mode-map): Bind "Q" and "TAB" to
xref-quit-and-goto-xref.

* doc/emacs/maintaining.texi (Xref Commands): Describe new bindings in
*xref*.

* etc/NEWS (Xref): Describe new binding.
2017-11-03 16:13:39 +00:00
Martin Rudalics
27964af438 In frame parameters documentation mention desktop saving/restoring
* doc/lispref/frames.texi (Frame Parameters): Mention that
applications have to care about which parameters they want to
get saved and restored by the desktop library.
2017-11-02 09:28:25 +01:00
Charles A. Roelli
460fe4a1bc ; Doc fixes
* lisp/progmodes/xref.el (xref-file-location)
(xref-backend-apropos):
* etc/NEWS (Lisp Changes in Emacs 26.1):
* doc/emacs/msdos.texi (Windows Keyboard):
* lisp/vc/vc.el (vc-print-branch-log):
* src/buffer.c (word-wrap): Doc additions and fixes.
2017-10-31 22:01:34 +01:00
Eli Zaretskii
ee493663ba Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/emacs into emacs-26 2017-10-30 20:47:06 +02:00
Eli Zaretskii
ca5eb0d0b7 Fix a typo in the ELisp manual
* doc/lispref/functions.texi (Obsolete Functions): Fix a typo.
(Bug#29068)
2017-10-30 20:45:39 +02:00
Martin Rudalics
d10c9479ca Fix doc and doc-strings for minibuffer window related functions (Bug#28978)
These fixes were suggested by Drew Adams.

* src/window.c (Fminibuffer_selected_window): Disambiguate
doc-string.
* doc/lispref/minibuf.texi (Intro to Minibuffers)
(Minibuffer Windows, Recursive Mini, Minibuffer Misc):  Avoid
the term "currently active minibuffer window".  Disambiguate
documentation of `minibuffer-selected-window'.
2017-10-30 19:43:29 +01:00
Martin Rudalics
4189d0ef7b Fix minibuffer window related docs and strings (Bug#28978)
* src/frame.c (Vdefault_minibuffer_frame): Fix doc-string.
* src/window.c (Fminibuffer_selected_window): Fix doc-string.
* doc/lispref/frames.texi (Buffer Parameters): Rewrite
description of `minibuffer' parameter.
* doc/lispref/minibuf.texi (Minibuffer Windows): Reorder
entries and partly rewrite section.
(Minibuffer Misc): Clarify description of
`minibuffer-selected-window'.
* etc/NEWS: Mention new semantics of 'minibuffer' frame
parameter.
2017-10-29 11:35:32 +01:00
Glenn Morris
82a16c547b Fix some duplicate word typos
* doc/misc/ede.texi (ede-target):
* doc/misc/flymake.texi (Using Flymake):
* doc/misc/gnus.texi (The namazu Engine): Fix typos.
2017-10-28 16:42:23 -07:00
Eli Zaretskii
266888b1d7 * doc/lispref/commands.texi (Adjusting Point): Fix wording. (Bug#29042) 2017-10-28 19:48:49 +03:00
Eli Zaretskii
9102fb603e Add Index to ERT manual
* doc/misc/ert.texi: Add @syncodeindex directives.
(Index): New node.
(Top): Add Index to the top-level menus.
Add index entries to all nodes.
2017-10-28 14:25:07 +03:00
Eli Zaretskii
68182a4710 Make manuals and NEWS consistent
* etc/NEWS: Fix markings on several entries, and rearrange others
as needed.

* doc/emacs/programs.texi (Hideshow): Document the new
outline-like bindings.
* doc/emacs/search.texi (Query Replace): Document 'u' and 'U'.
2017-10-28 13:29:29 +03:00
Glenn Morris
50f711e7fa Fix some duplicate words typos
* lisp/erc/erc.el (erc-hide-current-message-p):
* lisp/progmodes/flymake-proc.el (flymake-proc-diagnostic-type-pred):
* doc/lispref/display.texi (Bidirectional Display, Delayed Warnings):
* doc/lispref/functions.texi (Defining Functions):
* doc/lispref/os.texi (Terminal-Specific):
* doc/misc/sem-user.texi (Analyzer Debug):
* doc/misc/srecode.texi (Special Variables): Fix typos.
2017-10-27 20:45:23 -04:00
Eli Zaretskii
9e442a001a Improve documentation of how faces are applied to display stings
* doc/lispref/display.texi (Displaying Faces): Describe how the
faces of the "underlying" text affect overlay and display strings.
(Display Margins): Add a cross-reference to "Displaying Faces".
2017-10-27 17:43:21 +03:00
Eli Zaretskii
ec08d70b4f Improve documentation of set-default-file-modes
* src/fileio.c (Fset_default_file_modes): Doc fix.  (Bug#28875)

* doc/lispref/files.texi (Changing Files): Clarify how the bits in
the argument of set-default-file-modes are used for setting file
permissions.
2017-10-27 16:53:16 +03:00
Ulf Jasper
933b3a3ee8 Fix documentation of `newsticker-new-item-functions' (bug#29023).
* lisp/net/newst-backend.el (newsticker-new-item-functions),
(newsticker-new-item-functions-sample),
(newsticker-download-enclosures): Fix docstring, rename
variable feed to feedname (bug#29023).

* doc/misc/newsticker.texi (Automatic Processing)
(Automatic Processing): Fix documentation of
`newsticker-new-item-functions' (bug#29023).
2017-10-27 14:44:47 +02:00
Eli Zaretskii
4587d8e0ef Document 'minibuffer-with-setup-hook'
* doc/lispref/minibuf.texi (Minibuffer Misc): Document
minibuffer-with-setup-hook.  (Bug#28877)
2017-10-21 10:43:30 +03:00
Eli Zaretskii
fd3d8610b2 Make :align-to account for display-line-numbers
These changes also update the various bundled packages to use
new feature, and better support customizations of the line-number
face.
* src/xdisp.c (calc_pixel_width_or_height): Improve commentary.
Make :align-to count from the end of the line-number display when
the offset or the width form reference that of the text area.
(Bug#28855)

* src/indent.c (Fline_number_display_width): Implement support for
the PIXELWISE argument being 'columns'.  Update the doc string.
(syms_of_indent): New symbol 'columns'.

* lisp/ruler-mode.el (ruler-mode-window-col, ruler-mode-ruler):
Call line-number-display-width with last argument 'columns'.

* lisp/proced.el (proced-header-line): Call
line-number-display-width with 2nd arg 'columns', which also fixes
a problem when display-line-numbers is nil.

* lisp/emacs-lisp/tabulated-list.el
(tabulated-list-line-number-width): Call line-number-display-width
with 2nd arg 'columns.
(tabulated-list-entry-lnum-width): Remove unneeded defvar.
(tabulated-list-print, tabulated-list-print-entry): No need to
account for the value of tabulated-list-entry-lnum-width.
(tabulated-list--current-lnum-width): New defvar.
(tabulated-list-watch-line-number-width): New function.
(tabulated-list-mode): Bind tabulated-list--current-lnum-width
locally, and set up tabulated-list-watch-line-number-width as
pre-redisplay-functions hook.

* doc/lispref/display.texi (Size of Displayed Text): Document the
'columns' value of the PIXELWISE argument.
(Pixel Specification): Update and improve the documentation of the
supported forms.
2017-10-20 12:36:12 +03:00
João Távora
831eafc8ae Augment Flymake API for third-party extensions
See
https://lists.gnu.org/archive/html/emacs-devel/2017-10/msg00619.html

* doc/misc/flymake.texi (Flymake error types): Rewrite
example.
(Flymake utility functions): Augment with new API.

* lisp/progmodes/flymake.el (flymake-diagnostics): New function.
(flymake--diag-accessor): New helper macro.
(flymake-diagnostic-buffer, flymake-diagnostic-text)
(flymake-diagnostic-beg, flymake-diagnostic-end)
(flymake-diagnostic-backend): Accessors for diagnostic objects.
(flymake--overlays): Use flymake-diagnostic property.
(flymake--highlight-line): Simplify.  Only set
flymake-diagnostic property.
(flymake--handle-report, flymake-goto-next-error): Use
flymake-diagnostic property.
(flymake-show-diagnostic): Use diagnostic object.
(flymake--diagnostics-buffer-entries): Use
flymake-diagnostics.
2017-10-20 10:00:19 +01:00
João Távora
234b1e3864 Flymake backends must check proc obsoleteness in source buffer
Flymake backends that rely on sentinels running asynchronously and
checking buffer-local variables that hold running processes should
check for obsoleteness in the correct buffers, otherwise a (harmless)
warning might be triggered.

* doc/misc/flymake.texi (An annotated example backend):
Check buffer-local proc in the current buffer.

* lisp/progmodes/elisp-mode.el (elisp-flymake-byte-compile):
Check buffer-local proc in the current buffer.
2017-10-20 00:50:34 +01:00
Paul Eggert
6f1dea5c74 Spelling fixes
* lisp/cedet/semantic/analyze/refs.el:
(semantic-analyze-proto-impl-toggle): Fix recently-introduced
misspelling of pop-to-buffer-same-window.
2017-10-18 18:43:44 -07:00
Paul Eggert
8ca6fa585a Improve format-time-string doc
* doc/lispref/os.texi (Time Parsing): Fix some errors in the
documentation for format-time-string.  Document ^, #, %s, and %z
with colons.  Say that unrecognized sequences are output as-is.
* src/editfns.c (Fformat_time_string): %S can stand for 60.
Also mention unrecognized sequences.
2017-10-17 18:26:01 -07:00
Eli Zaretskii
2e1b3522b8 Improve documentation of 'line-number-display-width'
* doc/lispref/display.texi (Size of Displayed Text): Document the
additional 2 columns used for line-number display.

* src/indent.c (Fline_number_display_width): Doc fix.  (Bug#28248)
2017-10-17 19:17:22 +03:00
Martin Rudalics
4e59ecc646 Fix wording in Elisp manual's child frames section (Bug#28819)
* doc/lispref/frames.texi (Child Frames): Fix wording (Bug#28819).
2017-10-14 10:30:09 +02:00
João Távora
413978727c Simplify Flymake user documentation
Fix some confusing parts of Flymake user documentation, like a
repeated listing of situations leading to a syntax check.
Documentation is now divided into three chapters only: "Using
Flymake", "Extending Flymake", and a chapter for the legacy backend.

Obsolete mention of "errors" and "lines" is replaced by
"diagnostics/problems" and "regions" where appropriate.

* doc/misc/flymake.texi (Overview of Flymake): Delete chapter.
(Using Flymake): Merge with chapter "Overview of Flymake".
(Installing Flymake): Delete chapter.
(Flymake mode, Running the syntax check)
(Navigating to error lines): Delete sections.
(Syntax check statuses): Review and augment with x-references.
(Backend exceptions): Mention shortcut in menu.

* lisp/progmodes/flymake.el (flymake-menu): Tweak minor mode
menu to not speak of "errors".
(flymake-goto-next-error, flymake-goto-prev-error): Fix
wording.
2017-10-12 12:30:23 +01:00
Michael Albinus
e8a7c41b4e Format shell commands in tramp.texi
* doc/misc/tramp.texi (Obtaining Tramp, Remote shell setup):
Format shell commands better.
2017-10-11 10:57:29 +02:00
Eli Zaretskii
00adeb43e9 Improve the Flymake manual
* doc/misc/flymake.texi: Add a 'coding' cookie.  Add a
@syncodeindex directive for @vindex.  Use 2 spaces between
sentences.  Lower-case @cindex entries.
(Overview of Flymake): Fix use of @itemize and @pxref.  Fix
punctuation and markup.
(Backend exceptions): Use @emph instead of @dfn.  Add more
indexing.
(Customizable variables, Extending Flymake): Improve wording.
(Flymake error types): Fix usage of @itemize.  Improve wording.
(Backend functions): Fix punctuation.  Fix markup.  Add a
cross-reference to ELisp manual.
(Flymake utility functions): Add a cross-reference to ELisp manual.
(An annotated example backend): Fix punctuation and typos.
(Flymake mode, Running the syntax check)
(Navigating to error lines, Backend exceptions)
(Customizable variables, Flymake error types, Backend functions)
(Flymake utility functions, Proc customization variables)
(Locating a master file, Locating the buildfile)
(Starting the syntax check process, Parsing the output)
(Interaction with other modes): Fix indexing.  Add index entries
for functions, variables, and concepts.
2017-10-10 17:08:51 +03:00
João Távora
1c2e188440 Add full documentation on new Flymake API
Also, as a minor addition to this API, set flymake-text
on the diagnostic overlay.  This enables a good example in
the section "Customization Flymake annotations".

* doc/misc/flymake.texi (Overview of Flymake)
(Syntax check statuses): Rework.
(Backend exceptions): Rename from "Troubleshooting"
(Customizable variables): Add flymake-start-on-flymake-mode. Rework.
(Extending Flymake): Write chapter.
(Customizing Flymake annotations, Flymake backends)
(Flymake utility functions, An annotated example backend):
New sections and subsections

* lisp/progmodes/flymake.el (flymake-diagnostic-functions)
(flymake-diagnostic-types-alist): Rework docstring.
(flymake--highlight-line): Set and use flymake-text property in overlay.
(flymake-goto-next-error, flymake-goto-prev-error): Fix funny quotes.
2017-10-10 13:08:41 +01:00