1
Fork 0
mirror of git://git.sv.gnu.org/emacs.git synced 2025-12-30 09:00:31 -08:00
Commit graph

68 commits

Author SHA1 Message Date
Glenn Morris
4fa90ff8f5 Merge from origin/emacs-26
e5a2933 (origin/emacs-26) lisp/vc/: documentation fixes
f21f8e6 Document 'desktop-files-not-to-save'
d8917eb Improve documentation of Profiling features
b228839 Improve indexing of "performance" in ELisp manual
ab67b3e Minor change in Emacs manual's VC chapter
c352434 Avoid memory corruption with specpdl overflow + edebug (Bug#3...
593bbda Document comment-fill-column in the manual (Bug#11636)
bd4cc8d * doc/emacs/dired.texi (Marks vs Flags): Copyedits.
69107f3 ; Fix doc typos related to indefinite articles
aaad1e6 Merge branch 'emacs-26' of git.savannah.gnu.org:/srv/git/emac...
5906418 More fixes for the Emacs manual
9ab3df1 ; Fix doc typos related to indefinite articles
66a4e65 ; Fix doc typos related to indefinite articles
35e5c57 ; Fix doc typos related to indefinite articles
2018-02-17 07:50:28 -08:00
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
c4f8b5545e Merge from origin/emacs-26
56c37bb Use @key{} where it is missing in the manuals
25c0198 Another round of manual fixes from proofreading
2018-02-02 07:50:22 -08:00
Michael Albinus
56c37bbdb6 Use @key{} where it is missing in the manuals 2018-01-31 19:59:12 +01:00
Glenn Morris
81c2c2fa31 Merge from origin/emacs-26
8d45000 (origin/emacs-26) Fix some issues in the emacs/lispref manuals
194ded5 Fix multiple spaces in Emacs manual
57a5461 * lisp/files.el (save-some-buffers): Doc fix.  (Bug#30215)
231474f Adjudicate comments to "International" chapter of Emacs manual
2018-01-29 07:50:21 -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
Glenn Morris
6e141a2a15 Merge from origin/emacs-26
c9c1add6a4 * doc/lispref/variables.texi (File Local Variables): Fix l...
752fba992b (tag: emacs-26.0.91) ; * Update ldefs-boot.el
4f46a5098d * ChangeLog.3: Update
8f705ba44d Update etc/AUTHORS
6c63204b8c Fix an entry in authors-aliases
5dd0e5c54d Mention trace.el facilities in the ELisp manual
97b0e41c5d Improve documentation of safe values of variables
a502ee9dc4 ; * doc/emacs/misc.texi (Amusements): Really add "games" t...
106bf8adc3 Improve the Emacs manual's "Misc" node
47aa85c7ec In nsterm.m use FRAME_NS_P instead of FRAME_X_P (Bug#30019)
e9e32d3475 ; * Update ldefs-boot.el
2018-01-15 13:53:40 -08:00
Stefan Monnier
72ee93d68d * src/print.c (syms_of_print) <print_quoted>: Set default to true 2018-01-15 13:42:51 -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
Paul Eggert
5c7dd8a783 Update copyright year to 2018
Run admin/update-copyright.
2018-01-01 00:57:59 -08:00
Paul Eggert
5d51403ceb ; Typo fixes, mostly repeated words 2017-10-09 22:55:06 -07:00
Paul Eggert
bcf244ef9b Merge from origin/emacs-25
2e2a806 Fix copyright years by hand
5badc81 Update copyright year to 2017
2017-01-01 01:10:47 -08:00
Paul Eggert
5badc81c1c Update copyright year to 2017
Run admin/update-copyright.
2016-12-31 19:42:26 -08:00
Clément Pit--Claudel
27cada035a Move backtrace to ELisp using a new mapbacktrace primitive
* src/eval.c (get_backtrace_starting_at, backtrace_frame_apply)
(Fmapbacktrace, Fbacktrace_frame_internal): New functions.
(get_backtrace_frame, Fbacktrace_debug): Use `get_backtrace_starting_at'.

* lisp/subr.el (backtrace--print-frame): New function.
(backtrace): Reimplement using `backtrace--print-frame' and `mapbacktrace'.
(backtrace-frame): Reimplement using `backtrace-frame--internal'.

* lisp/emacs-lisp/debug.el (debugger-setup-buffer): Pass a base to
`mapbacktrace' instead of searching for "(debug" in the output of
`backtrace'.

* test/lisp/subr-tests.el (subr-test-backtrace-simple-tests)
(subr-test-backtrace-integration-test): New tests.

* doc/lispref/debugging.texi (Internals of Debugger): Document
`mapbacktrace' and missing argument BASE of `backtrace-frame'.
2016-12-12 17:41:27 -05:00
Noam Postavsky
56c817837b Document watchpoints
* doc/lispref/debugging.texi (Variable Debugging):
* doc/lispref/variables.texi (Watching Variables): New section.
* etc/NEWS: Add entry for watchpoints
2016-12-02 20:25:15 -05:00
Paul Eggert
394bdb8f23 Merge from origin/emacs-25
50fa7d6 ;* src/w32heap.c: Fix typo and wording of the comments.
6f1325e electric-quote mode no longer worries about coding
c2a1792 * src/regex.c (re_search_2): Make new code safe for -Wjump-mi...
f6134bb Port to GCC 6.2.1 + --enable-gcc-warnings
b2ba630 Explain how to debug emacsclient lisp errors
9da53e2 Let describe-function work for lambda again
5c2da93 Fix kill-line's docstring
ad66b3f Fix handling of allocation in regex matching
5a26c9b * lisp/electric.el (electric-quote-mode): Improve doc (Bug#24...
3877c91 vc-region-history: Search just on lines intersecting the region
8988327 Fix documentation of 'alist-get'
b6998ea * src/regex.h (re_match_object): Improve commentary.

# Conflicts:
#	etc/NEWS
#	lisp/help-fns.el
2016-10-23 02:50:48 -07:00
Noam Postavsky
b2ba630739 Explain how to debug emacsclient lisp errors
* doc/lispref/debugging.texi (Error Debugging): Mention that
debug-on-signal is useful for getting backtraces from
emacsclient (Bug#24616).
2016-10-22 12:06:29 -04:00
Paul Eggert
97046e811c Merge from origin/emacs-25
4b347fe Clarify that doc fixes are okay in feature freeze
01669ad Avoid crashes when setting the cursor
f2144ee Restore 'command-debug-status' functionality
ec6e4b9 ; Minor addition to CONTRIBUTE
2016-10-10 07:35:32 -07:00
Philippe Vaucher
f2144eef19 Restore 'command-debug-status' functionality
* src/callint.c (Fcall_interactively): Bind command-debug-status
to nil.  This restores functionality inadvertently removed in
Emacs 25.1.  (Bug#24555)

* lisp/subr.el (command-debug-status): Declare obsolete.

* doc/lispref/debugging.texi (Internals of Debugger): Document
that 'command-debug-status' is obsolete.
2016-10-04 17:34:51 +03:00
Vasilij Schneidermann
d1890a3a4a New user option 'debugger-stack-frame-as-list'
* src/eval.c (syms_of_eval) <debugger-stack-frame-as-list>: New
variable.
* lisp/cus-start.el (standard): Add debugger-stack-frame-as-list.
* lisp/emacs-lisp/debug.el (debugger-setup-buffer): Adjust
backtrace processing for the value of debugger-stack-frame-as-list.
* lisp/emacs-lisp/edebug.el (edebug-backtrace): Adjust backtrace
processing for the value of debugger-stack-frame-as-list.
* doc/lispref/debugging.texi (Internals of Debugger): Document
debugger-stack-frame-as-list.
* etc/NEWS: Mention 'debugger-stack-frame-as-list'.
2016-09-30 16:22:26 +03:00
Noam Postavsky
272391f1d6 profiler: document prefix arg for tree expansion
* doc/lispref/debugging.texi (Profiling):
* lisp/profiler.el (profiler-report-toggle-entry): Document use of
prefix argument to expand whole call trees.
2016-07-28 20:02:42 -04:00
Martin Rudalics
e639e10a63 Some corrections in Elisp manual
* doc/lispref/buffers.texi (Read Only Buffers): Describe optional
argument POSITION.
* doc/lispref/debugging.texi (Error Debugging): `debug-on-signal'
is an option.
* doc/lispref/display.texi (Refresh Screen): Describe optional
argument FRAME of `redraw-frame'.
(Attribute Functions): Describe optional argument CHARACTER of
`face-font'.
(Defining Images): `image-load-path' is an option.
(Beeping): `ring-bell-function' is an option.
* doc/lispref/frames.texi (Size and Position): The PIXELWISE
argument of `set-frame-size' is optional.
(Raising and Lowering): The TERMINAL argument of `tty-top-frame'
is optional.
* doc/lispref/keymaps.texi (Controlling Active Maps): Fix doc of
`set-transient-map'.
* doc/lispref/minibuf.texi (Text from Minibuffer):
`read-regexp-defaults-function' is an option.
(Minibuffer Contents): `delete-minibuffer-contents' is a command.
* doc/lispref/modes.texi (Mode Line Variables):
`mode-line-position' and `mode-line-modes' are variables, not
options.
* doc/lispref/strings.texi (Creating Strings): The START argument
of `substring' is optional.
* doc/lispref/text.texi (Buffer Contents): Describe optional
argument NO-PROPERTIES of `thing-at-point'.
(User-Level Deletion): Both arguments of
`delete-trailing-whitespace' are optional.
(Margins): Use @key{RET} instead of @kbd{RET}.
* doc/lispref/windows.texi (Display Action Functions): Write
non-@code{nil} instead of non-nil.
(Choosing Window Options): The WINDOW arg of
`split-window-sensibly' is optional.
(Choosing Window Options): Write non-@code{nil} instead of
non-nil.
(Window Start and End): Both args of `window-group-end' are
optional.

* src/buffer.c (Fbarf_if_buffer_read_only): Rename argument POS
to POSITION to keep consisteny with doc-string.
2016-02-01 19:01:34 +01:00
Paul Eggert
0e963201d0 Update copyright year to 2016
Run admin/update-copyright.
2016-01-01 01:34:24 -08:00
Paul Eggert
ef7dbdf587 Quote less in manuals
The manuals often used quotes ``...'' when it is better to use @dfn or
@code or capitalized words or no quoting at all.  For example, there is
no need for the `` and '' in “if a variable has one effect for
@code{nil} values and another effect for ``non-@code{nil}'' values”.
Reword the Emacs, Lisp intro, and Lisp reference manuals to eliminate
unnecessary quoting like this, and to use @dfn etc. instead when called
for (Bug#21472).
2015-09-15 08:48:44 -07:00
Eli Zaretskii
21f7a70dcc * doc/lispref/debugging.texi (Profiling): Improve indexing.
(Bug#20576)
2015-05-16 17:30:50 +03:00
Paul Eggert
7e09ef09a4 Update copyright year to 2015
Run admin/update-copyright.
2015-01-01 14:26:41 -08:00
Eli Zaretskii
20cfd2480d Improve indexing on the chapter/section/subsection levels.
doc/lispref/windows.texi (Recombining Windows): Index subject of sections.
 doc/lispref/variables.texi (Variables with Restricted Values)
 (Generalized Variables): Index subject of sections.
 doc/lispref/text.texi (Buffer Contents, Examining Properties)
 (Changing Properties, Property Search, Substitution): Index
 subject of sections.
 doc/lispref/syntax.texi (Motion and Syntax, Parsing Expressions)
 (Motion via Parsing, Position Parse, Control Parsing): Index
 subject of sections.
 doc/lispref/strings.texi (Predicates for Strings, Creating Strings)
 (Modifying Strings, Text Comparison): Index subject of sections.
 doc/lispref/searching.texi (Syntax of Regexps, Regexp Special)
 (Regexp Functions, Regexp Functions): Index subject of sections.
 doc/lispref/processes.texi (Subprocess Creation, Process Information): Index
 subject of sections.
 doc/lispref/positions.texi (Screen Lines): Index subject of sections.
 doc/lispref/nonascii.texi (Scanning Charsets, Specifying Coding Systems):
 Index subject of sections.
 doc/lispref/minibuf.texi (Text from Minibuffer, Object from Minibuffer)
 (Multiple Queries, Minibuffer Contents): Index subject of
 sections.
 doc/lispref/markers.texi (Predicates on Markers, Creating Markers)
 (Information from Markers, Moving Markers): Index subject of
 sections.
 doc/lispref/macros.texi (Defining Macros, Problems with Macros): Index
 subject of sections.
 doc/lispref/loading.texi (Loading Non-ASCII, Where Defined): Index subject
 of sections.
 doc/lispref/lists.texi (List-related Predicates, List Variables, Setcar)
 (Setcdr, Plist Access): Index subject of sections.
 doc/lispref/keymaps.texi (Controlling Active Maps, Scanning Keymaps)
 (Modifying Menus): Index subject of sections.
 doc/lispref/help.texi (Accessing Documentation, Help Functions): Index
 subject of sections.
 doc/lispref/hash.texi (Hash Access): Index subject of sections.
 doc/lispref/functions.texi (Core Advising Primitives)
 (Advising Named Functions, Porting old advices): Index subject of
 sections.
 doc/lispref/frames.texi (Creating Frames, Initial Parameters)
 (Position Parameters, Buffer Parameters, Minibuffers and Frames)
 (Pop-Up Menus, Drag and Drop): Index subject of sections.
 doc/lispref/files.texi (Visiting Functions, Kinds of Files)
 (Unique File Names): Index subject of sections.
 doc/lispref/display.texi (Refresh Screen, Echo Area Customization)
 (Warning Variables, Warning Options, Delayed Warnings)
 (Temporary Displays, Managing Overlays, Overlay Properties)
 (Finding Overlays, Size of Displayed Text, Defining Faces)
 (Attribute Functions, Displaying Faces, Face Remapping)
 (Basic Faces, Font Lookup, Fontsets, Replacing Specs)
 (Defining Images, Showing Images): Index subject of sections.
 doc/lispref/debugging.texi (Debugging, Explicit Debug)
 (Invoking the Debugger, Excess Open, Excess Close): Index subject
 of sections.
 doc/lispref/customize.texi (Defining New Types, Applying Customizations)
 (Custom Themes): Index subject of sections.
 doc/lispref/control.texi (Sequencing, Combining Conditions)
 (Processing of Errors, Cleanups): Index subject of sections.
 doc/lispref/compile.texi (Eval During Compile): Index subject of sections.
 doc/lispref/commands.texi (Using Interactive, Distinguish Interactive)
 (Command Loop Info, Classifying Events, Event Mod)
 (Invoking the Input Method): Index subject of sections.
 doc/lispref/buffers.texi (Buffer List, Buffer Gap): Index subject of sections.
 doc/lispref/backups.texi (Making Backups, Numbered Backups, Backup Names)
 (Reverting): Index subject of sections.
 doc/lispref/abbrevs.texi (Abbrev Tables, Defining Abbrevs, Abbrev Files)
 (Abbrev Expansion, Standard Abbrev Tables, Abbrev Properties)
 (Abbrev Table Properties): Index subject of sections.
 doc/lispref/os.texi (Time of Day, Time Conversion, Time Parsing)
 (Time Calculations, Idle Timers): Index subject of sections.
2014-12-23 20:42:30 +02:00
Stefan Monnier
c838708452 * doc/lispref/debugging.texi (Function Debugging, Debugger Commands):
Update debug-on-entry w.r.t behavior after redefinitions.

Fixes: debbugs:17902
2014-07-08 14:24:39 -04:00
Glenn Morris
47a73eb071 Small doc updates for debugging
* doc/lispref/debugging.texi (Debugger Commands): Tiny edits.

* lisp/jit-lock.el (jit-lock-mode): Doc fix.

* etc/NEWS: Related edits.
2014-02-13 00:26:01 -08:00
Paul Eggert
ba3189039a Update copyright year to 2014 by running admin/update-copyright. 2014-01-01 07:43:34 +00:00
Xue Fuqiao
c9832cd810 Document `debugger-toggle-locals'.
* doc/lispref/debugging.texi (Debugger Commands): Document `debugger-toggle-locals'.
2013-12-22 11:36:04 +08:00
Glenn Morris
a944db142f Fix some doc/ cross-references
* doc/lispintro/emacs-lisp-intro.texi (edebug):
* doc/lispref/debugging.texi (Debugging):
* doc/lispref/files.texi (File Attributes, Changing Files):
* doc/misc/bovine.texi (top):
* doc/misc/cc-mode.texi (AWK Mode Font Locking):
* doc/misc/mh-e.texi (Preface):
* doc/misc/url.texi (URI Parsing):
Fix cross-references to other manuals.

* doc/lispref/package.texi (Package Archives): Fix @url call.
2013-07-02 20:03:47 -07:00
Paul Eggert
ab422c4d68 Update copyright notices for 2013. 2013-01-01 09:11:05 +00:00
Stefan Monnier
365fc14aa4 * doc/lispref/debugging.texi (Profiling): Make it more clear
that --enable-profiling is about profiling the C code.
2012-11-21 09:14:42 -05:00
Glenn Morris
b6729a180f Add a bit more about profiling to the lispref
* doc/lispref/debugging.texi (Profiling):
Add some basic information about the profile report buffer.
(Debugging): Mention profiling in the introduction.
2012-11-20 20:52:03 -05:00
Glenn Morris
38a2f91778 * doc/lispref/debugging.texi (Profiling) [!tex]: Mention --enable-profiling. 2012-11-20 20:32:09 -05:00
Glenn Morris
1faaca8ac8 Fix typos in previous 2012-11-20 00:47:57 -08:00
Glenn Morris
5b776637e1 Make a start on a Profiling section in the lispref
* doc/lispref/debugging.texi (Profiling): New section, in progress.
* doc/lispref/tips.texi (Compilation Tips): Move profiling to separate section.
* doc/lispref/elisp.texi: Add Profiling to detailed menu.
2012-11-20 00:02:54 -08:00
Glenn Morris
57fc0fee5f Document debugger-bury-or-kill
* doc/lispref/debugging.texi (Using Debugger): Mention debugger-bury-or-kill.

* lisp/emacs-lisp/debug.el (debugger-bury-or-kill): Doc tweak.

* etc/NEWS: Related edit.
2012-11-10 17:16:25 -08:00
Glenn Morris
164f28b577 * doc/lispref/debugging.texi (Error Debugging): Mention debug-on-message.
* etc/NEWS: Related markup.
2012-11-10 16:58:51 -08:00
Glenn Morris
38868ad716 Document new error symbol and function user-error
* doc/lispref/control.texi (Signaling Errors):
* doc/lispref/debugging.texi (Error Debugging):
* doc/lispref/errors.texi (Standard Errors): Add user-error.

* etc/NEWS: Related markup.
2012-11-10 16:37:40 -08:00
Chong Yidong
acfa068f4a Merge from emacs-24; up to 2012-05-07T14:57:18Z!michael.albinus@gmx.de 2012-09-21 11:03:48 +08:00
Glenn Morris
1bfe31778b * doc/lispref/debugging.texi (Using Debugger): Fix typo. 2012-09-11 22:18:43 -04:00
Lars Ingebrigtsen
7f7e0167cf Implement `debug-on-message'.
This allows tracking down what piece of code is outputting stuff in
the echo area.

* eval.c (call_debugger): Make the function non-static so that we
can call it from set_message.

* xdisp.c (set_message): Implement the new variable `debug-on-message'.
(syms_of_xdisp): Defvar it and `inhibit-debug-on-message'.
2012-09-04 23:21:00 +02:00
Glenn Morris
ecc6530da9 Nuke hand-written node pointers in doc/lispref
Let makeinfo figure them out, as is recommended.
2012-05-26 18:34:14 -07:00
Glenn Morris
33017fafd1 Merge from emacs-24; up to 2012-04-24T08:35:02Z!lekktu@gmail.com 2012-05-26 18:06:44 -07:00
Martin Rudalics
0b128ac426 Some minor fixes of Elisp manual.
* commands.texi (Recursive Editing): recursive-edit is a
command.
* compile.texi (Docs and Compilation):
byte-compile-dynamic-docstrings is an option.
* debugging.texi (Invoking the Debugger): debug is a command.
* display.texi (Progress): progress-reporter-update and
progress-reporter-force-update have VALUE argument optional.
(Animated Images): Use non-@code{nil} instead of non-nil.
* files.texi (Format Conversion Round-Trip): Use non-@code{nil}
instead of non-nil.
* frames.texi (Creating Frames): make-frame is a command.
(Input Focus): select-frame is a command.
(Pointer Shape): void-text-area-pointer is an option.
* help.texi (Describing Characters): read-kbd-macro is a
command.
(Help Functions): describe-prefix-bindings is a command.
* markers.texi (Creating Markers): Both arguments of copy-marker
are optional.
* minibuf.texi (Reading File Names): Use @kbd instead of @code.
* modes.texi (Mode Line Variables): mode-line-remote and
mode-line-client are not options.
(Imenu): imenu-add-to-menubar is a command.
(SMIE Indentation Helpers): Use non-@code{nil} instead of
non-nil.
* os.texi (Sound Output): play-sound-file is a command.
* package.texi (Package Archives): Use @key{RET} instead of
@kbd{RET}.
* processes.texi (Signals to Processes): Use @key{RET} instead
of @code{RET}.
(Signals to Processes): signal-process is a command.
* text.texi (Clickable Text): Use @key{RET} instead of
@kbd{RET}.
(Base 64): base64-encode-string is not a command while
base64-decode-region is.
* windows.texi (Switching Buffers): pop-to-buffer is a command.
2012-05-15 11:38:50 +02:00
Glenn Morris
1e103a7cd8 Remove unnecessary @setfilename commands from many doc/lispref/*.texi 2012-04-13 18:59:01 -07:00
Glenn Morris
2bb0eca1eb In doc/lispref, use @file for buffers, per the Texinfo manual.
It renders the same as @samp, so there is no visible change in most cases.
2012-04-10 00:11:23 -07:00