1
0
mirror of https://git.savannah.gnu.org/git/emacs.git synced 2024-12-14 09:39:42 +00:00
Commit Graph

2770 Commits

Author SHA1 Message Date
Eli Zaretskii
d8917eba1c Improve documentation of Profiling features
* doc/lispref/debugging.texi (Profiling): Improve the description
of elp.el.  Improve wording of the rest of the section.  (Bug#30491)

* lisp/emacs-lisp/elp.el (elp-instrument-list): Make the
interactive invocation work.  Doc fix.
2018-02-17 11:59:36 +02:00
Eli Zaretskii
b228839af1 Improve indexing of "performance" in ELisp manual
* doc/lispref/debugging.texi (Profiling):
* doc/lispref/edebug.texi (Coverage Testing): Improve indexing of
features useful for performance analysis.  (Bug#30490)
2018-02-17 11:16:35 +02:00
Glenn Morris
69107f347b ; Fix doc typos related to indefinite articles 2018-02-16 17:33:57 -05:00
Glenn Morris
35e5c57db3 ; Fix doc typos related to indefinite articles 2018-02-16 14:11:51 -05:00
Eli Zaretskii
53511f9147 Another set of changes for the manual
* doc/emacs/programs.texi (Program Indent): Add a cross-reference
to elisp's description of 'pp'.
(Program Modes): Add a few more programming modes.  Add index
entries.
(Basic Indent, Multi-line Indent, C Indent, Comment Commands)
(Manipulating Comments): Fix markup of keyboard commands.
* doc/emacs/search.texi (Regexps): Add an example with non-ASCII
characters.  Suggested by Michael Albinus <michael.albinus@gmx.de>
in emacs-manual-bugs@gnu.org.

* doc/lispref/display.texi (Display Tables): Fix the description
of the 5th extra slot of the display table.  (Bug#13473)

* doc/emacs/regs.texi (Registers): Simplify wording.

* doc/emacs/custom.texi (Init Non-ASCII): Remove outdated text
about perils of encoded keyboard input.
2018-02-14 21:00:59 +02:00
Michael Albinus
8f7d718499 * doc/lispref/anti.texi (Antinews): Replace 25.2 with 25.3. 2018-02-09 13:04:12 +01:00
Eli Zaretskii
989d0afce9 Improve documentation of mini-window resizing
* doc/lispref/minibuf.texi (Minibuffer Windows): Mention
'message-truncate-lines' for preventing resizing of minibuffer
windows.  (Bug#19045)
(Minibuffer Misc): Remove redundant description of
'max-mini-window-height'.
* doc/lispref/display.texi (Echo Area Customization): Adjust
cross-reference.
2018-02-09 12:28:59 +02:00
Noam Postavsky
2dd273b985 Mention that shell quoting of % on w32 may fail (Bug#19350)
* doc/lispref/os.texi (Security Considerations): Mention that quoting
of '%' assumes no '^' in variable names.
* test/lisp/subr-tests.el (shell-quote-argument-%-on-w32): New test,
demonstrating what doesn't work.
2018-02-08 19:10:11 -05:00
Paul Eggert
979944c9b0 * doc/lispref/anti.texi (Antinews): Add some more antinews. 2018-02-08 15:59:19 -08:00
Noam Postavsky
04c5bd5b1f Doc fixes for process functions (Bug#30349)
* doc/lispref/processes.texi (Asynchronous Processes): Explain what
the 'stopped' state means for a pipe process.
* src/process.c (Fmake_process, Fmake_pipe_process)
(Fmake_serial_process, Fmake_network_process):
* lisp/subr.el (start-process):
* lisp/net/tls.el (open-tls-stream):
* lisp/net/starttls.el (starttls-open-stream):
* lisp/net/gnutls.el (open-gnutls-stream): Remove meaningless phrase
"specify an output stream" phrase from docstring.
2018-02-07 20:17:50 -05:00
Eli Zaretskii
5fe81923e5 Yet another round of improvements in the manual
* doc/emacs/misc.texi (Document View): Improve wording.  Reported
by lyr3 <lyr3@protonmail.com> in emacs-manual-bugs@gnu.org.

* doc/emacs/files.texi (Recover): Fix a typo.  Reported by Jorge
<jorge+list@disroot.org> in emacs-manual-bugs@gnu.org.

* doc/emacs/anti.texi (Antinews): Fix typos.  Reported by Justin
Heyes-Jones <justinhj@gmail.com> in emacs-manual-bugs@gnu.org.

* doc/emacs/mini.texi (Basic Minibuffer): Clarify wording.
Reported by Vivishek Sudhir <vivishek.sudhir@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (MS-Windows Registry): Improve wording
regarding registry keys.

* doc/emacs/macos.texi (Mac OS / GNUstep): Sayu "NeXT Inc."
Reported by Cena Mayo <cenazoic@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/screen.texi (Screen): More accurate wording.
Suggested by Miloš Polakovič <milos@alphamail.org> in
emacs-manual-bugs@gnu.org.

* doc/emacs/indent.texi (Just Spaces): Minor wording change.
Suggested by David Bonnafous <dbonnafo@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/text.texi (TeX Mode, TeX Editing): Improve and
simplify wording.  Suggested by root@vxid.pw <root@vxid.pw> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (Window Size X): Minor wording change.

* doc/emacs/display.texi (Highlight Interactively): Fill text.
(Optional Mode Line): Fix typos.  Suggested by Alberto Sartori
<alberto.sartori@sissa.it> in emacs-manual-bugs@gnu.org.

* doc/emacs/building.texi (Debugger Operation): Clarify wording.

* doc/emacs/files.texi (Directories, Comparing Files, Diff Mode)
(Remote Files, File Names, Visiting, Backup Deletion)
(Customize Save, Interlocking): Improve wording and accuracy of
the text.
* doc/emacs/maintaining.texi (VC With A Merging VCS): Don't say
"his".
* doc/emacs/arevert-xtra.texi (Auto Reverting Dired): Minor
wording changes.
(Supporting additional buffers): Moved to ...
* doc/lispref/backups.texi (Reverting): ... here.
* doc/emacs/emacs.texi (Top): Remove "Supporting additional
buffers" from master menu.
* doc/emacs/files.texi (Reverting): Mention use of file
notifications.  Suggested by Michael Albinus
<michael.albinus@gmx.de> in emacs-manual-bugs@gnu.org.

* doc/emacs/rmail.texi (Rmail Motion): Clarify what '-' does to
'M-s'.  Suggested by Arthur Milchior <arthur@milchior.fr> in
emacs-manual-bugs@gnu.org.

* doc/emacs/cmdargs.texi (Initial Options): Capitalize "Emacs".
(Action Arguments): Fix a typo.
(Emacs Invocation): Replace em-dash with a comma.  Suggested by
Justin Heyes-Jones <justinhj@gmail.com> in
emacs-manual-bugs@gnu.org.

* doc/emacs/m-x.texi (M-x): Add an example.  Suggested by Alberto
Sartori <alberto.sartori@sissa.it> in emacs-manual-bugs@gnu.org.

* doc/emacs/calendar.texi (Calendar/Diary, Calendar Unit Motion):
Minor wording changes.
2018-02-07 22:24:13 +02:00
Basil L. Contovounesios
59344c43a9 * doc/lispref/customize.texi (Custom Themes): Clarify .el preference.
Copyright-paperwork-exempt: yes

https://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00824.html.
2018-02-02 09:22:53 -05:00
Noam Postavsky
e21f0189f3 * doc/lispref/functions.texi (Inline Functions): Fix typo (Bug#30238). 2018-02-01 19:26:40 -05:00
Eli Zaretskii
b90e91ca54 Fix last change of @key markup
* doc/lispref/display.texi (Specified Space):
* doc/emacs/programs.texi (C Modes):
* doc/emacs/killing.texi (Rectangles):
* doc/emacs/emacs.texi (Top):
* doc/emacs/display.texi (Useless Whitespace): Don't use @key
markup for characters and commands, only for keys.
2018-02-01 19:56:51 +02:00
Michael Albinus
56c37bbdb6 Use @key{} where it is missing in the manuals 2018-01-31 19:59:12 +01:00
Martin Rudalics
59657c482d Document 'window-at-side-p' in the Elisp manual
* doc/lispref/windows.texi (Windows and Frames): Document
'window-at-side-p'.
2018-01-31 09:35:15 +01:00
Noam Postavsky
2b35ed0b0c Document external-debugging-output in the Elisp Manual (Bug#24051)
* doc/lispref/streams.texi (Output Streams): List
external-debugging-output.
* src/print.c (Fexternal_debugging_output): Quote `print' in
docstring.
2018-01-30 22:29:13 -05:00
Noam Postavsky
f706c59093 Update manual description of locate-file (Bug#23650)
* doc/lispref/files.texi (Locating Files): Add example of predicate
when searching for a directory.
2018-01-30 22:14:02 -05:00
Eli Zaretskii
691431eb09 Resurrect lost text in lispref
* doc/lispref/files.texi (File Attributes): Resurrect
inadvertently lost text.
2018-01-30 15:13:18 +02:00
Paul Eggert
7d90d2ece0 Proofread os.texi and files.texi 2018-01-29 10:38:06 -08:00
Martin Rudalics
8d4500087f Fix some issues in the emacs/lispref manuals
* doc/emacs/basic.texi (Continuation Lines):
* doc/emacs/building.texi (GDB User Interface Layout):
* doc/emacs/dired.texi (Misc Dired Features):
* doc/emacs/maintaining.texi (Identifier Search):
* doc/emacs/mark.texi (Using Region):
* doc/emacs/misc.texi (Document View, DocView Conversion):
* doc/emacs/modes.texi (Major Modes):
* doc/emacs/mule.texi (Input Methods, Unibyte Mode):
* doc/emacs/sending.texi (Mail Methods): Replace @code by
@kbd.
* doc/emacs/frames.texi (Text-Only Mouse):
* doc/lispref/maps.texi (Standard Keymaps): Replace @kbd by
@key.
* doc/lispref/compile.texi (Compiler Errors): Write
non-@code{nil} instead of non-nil.
* doc/lispref/debugging.texi (Internals of Debugger):
'backtrace' is not a command.  'debugger-stack-frame-as-list'
is an option.
* doc/lispref/display.texi (Size of Displayed Text):
'window-lines-pixel-dimensions' has a last argument 'left'.
* doc/lispref/display.texi (Attribute Functions):
'set-face-underline' and 'set-face-inverse-video' are
commands.
(Tooltips): 'tooltip-frame-parameters' is an option.
(Bidirectional Display): 'bidi-paragraph-direction' is an
option.
* doc/lispref/frames.texi (Cursor Parameters): 'cursor-type'
is an option.
(Input Focus): Argument FRAME of 'x-focus-frame' is not
optional.
(Child Frames): Both arguments of 'frame-ancestor-p' are
non-optional.  'iconify-child-frame' is an option.
* doc/lispref/os.texi (Killing Emacs):
'kill-emacs-query-functions' is an option.
* doc/lispref/windows.texi (Mouse Window Auto-selection):
'mouse-autoselect-window' is an option.
2018-01-28 19:27:39 +01:00
Eli Zaretskii
085ee439bf Improve documentation of 'edebug-defun'
* doc/lispref/edebug.texi (Instrumenting): Document a workaround
for a failure to instrument due to unknown macros.  (Bug#30243)
(Bug#10577)
2018-01-27 12:01:54 +02:00
Noam Postavsky
463f96b481 * doc/lispref/searching.texi: Document regexp repetition limit. 2018-01-26 19:53:09 -05:00
Eli Zaretskii
226a651e9e Minor fix in documentation of 'equal'
* doc/lispref/objects.texi (Equality Predicates): Correct the
conditions for equality of unibyte and multibyte strings.
(Bug#30218)
2018-01-26 12:38:07 +02:00
Eli Zaretskii
155b211133 Minor copyedit in ELisp manual
* doc/lispref/variables.texi (File Local Variables): Improve
wording of last change.
2018-01-14 18:48:05 +02:00
Stefan Monnier
c9c1add6a4 * doc/lispref/variables.texi (File Local Variables): Fix last change 2018-01-13 17:02:50 -05:00
Eli Zaretskii
5dd0e5c54d Mention trace.el facilities in the ELisp manual
* doc/lispref/debugging.texi (Debugging): Mention the trace.el
library.
2018-01-13 13:53:47 +02:00
Eli Zaretskii
97b0e41c5d Improve documentation of safe values of variables
* doc/lispref/variables.texi (File Local Variables): Mention the
autoload cookie as a means of defining safe values for variables.
See http://lists.gnu.org/archive/html/emacs-devel/2018-01/msg00261.html
for the details.
* doc/lispref/compile.texi (Compiler Errors): Document
'byte-compile-error-on-warn'.
2018-01-13 12:48:07 +02:00
Eli Zaretskii
106bf8adc3 Improve the Emacs manual's "Misc" node
* doc/emacs/misc.texi (Gnus): A more descriptive section name.
(Invoking emacsclient): Mention how to avoid errors when there's
no Emacs server.
(EWW, Embedded WebKit Widgets): Now subsections under
"Hyperlinking and Web Navigation Features".
(Amusements): Add "games" to the section name.  Suggested by Alex
Branham <alex.branham@gmail.com> in emacs-manual-bugs@gnu.org.

* doc/emacs/emacs.texi (Top): Adjust the top-level menus to the
above changes.

* doc/lispref/os.texi (Security Considerations): Fix typos.
2018-01-13 11:45:04 +02:00
Eli Zaretskii
a5f718c4c5 ; * doc/lispref/text.texi (Change Hooks): Fix last change. 2018-01-06 21:43:04 +02:00
Alan Mackenzie
e876f5f9fb Describe the precise interaction of complex primitives with the change hooks
* doc/lispref/text.texi (Change Hooks): Document that most buffer changing
primitives call before- and after-change-functions in balanced pairs, but that
some complex primitives call b-c-f once, and a-c-f zero, one, or several
times.
2018-01-06 18:55:08 +00:00
Stephen Leake
c967ba1861 Fix description of 'struct' generic function specializer
Backport:

* doc/lispref/functions.texi (Generic Functions): Fix description of
'struct' specializer; it must be the named struct or a child, not a
parent.

(cherry picked from commit b6add8c7cf)
2018-01-04 16:24:19 -06:00
Eli Zaretskii
b87a772612 Fix description of 'emacs-internal'
* doc/lispref/nonascii.texi (Coding System Basics): Correct
inaccuracy in description of 'emacs-internal'.  (Bug#29916)
2018-01-01 18:36:28 +02:00
Paul Eggert
63b04c11d5 Fix copyright years by hand
These are dates that admin/update-copyright did not update, or
updated incorrectly.
2018-01-01 01:02:09 -08:00
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Glenn Morris
fd35804971 * doc/lispref/strings.texi (Case Conversion):
Use a TeX font that support ligatures.
2017-12-27 09:55:35 -08:00
Eli Zaretskii
b882d4ef11 Fix problems with ligatures in PDF version of ELisp manual
* doc/lispref/strings.texi (Case Conversion): Avoid problems with
ligatures in printed versions of the manual.  (Bug#29818)
2017-12-23 10:34:42 +02:00
Glenn Morris
cf36c82127 Avoid some overfull lines in PDF lispref
* doc/lispref/commands.texi (Reading One Event):
* doc/lispref/display.texi (SVG Images):
* doc/lispref/frames.texi (Size Parameters):
* doc/lispref/syntax.texi (Categories):
* doc/lispref/windows.texi (Frame Layouts with Side Windows):
Avoid overfull lines.
2017-12-22 16:26:08 -05:00
Glenn Morris
7ffb7b1e01 ; lispref nil/t markup fixes 2017-12-22 13:45:46 -05:00
Eli Zaretskii
c3b6742b3f Improve documentation of selecting windows
* doc/lispref/windows.texi (Basic Windows, Selecting Windows):
Clarify what selecting a window means for keyboard input, and that
input focus may need to be considered when selecting windows on
other frames.  See
http://lists.gnu.org/archive/html/emacs-devel/2017-12/msg00372.html
for more details.
2017-12-22 12:18:12 +02:00
Eli Zaretskii
861d110078 Improve documentation of records
* doc/lispref/Makefile.in (srcs): Add the forgotten records.texi.
* doc/lispref/records.texi (Records): Recommend that record type
names use package-naming conventions.

* etc/NEWS: Add the naming convention recommendation for record
types.
2017-12-22 12:04:23 +02:00
Martin Rudalics
164e84c977 Fix uses of 'nil' and 'non-nil' in manuals and a few more minor issues
* doc/emacs/building.texi (Grep Searching): Fix doc of
'grep-save-buffers'.
(Drag and Drop): Reorder paragraphs.  Fix doc of
'mouse-drag-and-drop-region'.
* doc/emacs/frames.texi (Word and Line Mouse):
* doc/emacs/search.texi (Other Repeating Search):
* doc/lispref/compile.texi (Compilation Functions):
* doc/lispref/files.texi (Directory Names):
* doc/lispref/functions.texi (Advising Named Functions):
* doc/lispref/keymaps.texi (Controlling Active Maps):
* doc/lispref/lists.texi (Association Lists):
* doc/lispref/windows.texi (Quitting Windows): Fix uses of
'non-nil' and 'nil'.
2017-12-22 09:20:41 +01:00
Philipp Stephani
798f07f150 Document that mode commands should be idempotent.
* doc/lispref/modes.texi (Major Mode Conventions, Minor Mode
Conventions): Document that the mode commands should be idempotent.
2017-12-21 21:49:08 +01:00
Dmitry Gutov
aca827b0d0 Merge branch 'widen-less' into emacs-26 2017-12-21 00:34:07 +02:00
Dmitry Gutov
446faf3efa Replace the mention of c-indent-defun with js-indent-line
* doc/lispref/text.texi (Mode-Specific Indent):
Avoid mentioning c-indent-defun in the context of multi-mode
indentation.
2017-12-18 02:30:41 +02:00
Eli Zaretskii
ffd4771560 * doc/lispref/sequences.texi (Sequence Functions): Improve indexing. 2017-12-16 16:54:32 +02:00
Eli Zaretskii
7890864413 Improve documentation of 'invisible-p'
* doc/lispref/display.texi (Invisible Text): Document the return
value of 'invisible-p'.

* src/xdisp.c (Finvisible_p): Rename the argument POS.  Doc fix.
(Bug#29721)
2017-12-16 12:15:06 +02:00
Dmitry Gutov
7e9eef0ffd Consolidate 'widen' calls
* lisp/progmodes/prog-mode.el (prog-indentation-context):
Un-document all elements but the first.
(prog-widen): Remove.
(http://lists.gnu.org/archive/html/emacs-devel/2017-12/msg00321.html)

* doc/lispref/text.texi (Mode-Specific Indent): Update.

* lisp/progmodes/ruby-mode.el (ruby-calculate-indent):
Don't call widen.

* lisp/progmodes/python.el
(python-indent-guess-indent-offset)
(python-info-current-defun): Replace prog-widen with widen;
these functions are not called during indentation.
(python-indent-context)
(python-indent--calculate-indentation)
(python-info-dedenter-opening-block-message)
(python-info-line-ends-backslash-p)
(python-info-beginning-of-backslash)
(python-info-continuation-line-p)
(python-info-current-defun): Remove 'widen' calls.

* lisp/indent.el (indent-according-to-mode)
(indent-for-tab-command, indent-region): Move them here.

* lisp/textmodes/mhtml-mode.el (mhtml-indent-line):
Bind prog-indentation-context to one-element list.
2017-12-14 11:18:51 +02:00
Eli Zaretskii
d23158777d Fix fontset documentation inconsistencies for bug#29630
* doc/lispref/display.texi (Face Attributes): Don't document
:family as accepting a fontset.  Document that :font accepts a
fontset.

* lisp/faces.el (set-face-attribute): Doc fix.
2017-12-10 19:19:40 +02:00
Martin Rudalics
a829cb8c8b Remove sentence from child frames section in Elisp manual
* doc/lispref/frames.texi (Child Frames): Remove one sentence.
Suggested by Bob Weiner <rsw@gnu.org>.
2017-12-10 10:38:08 +01:00