[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-26 2b35ed0 8/8: Document external-debugging-output i
From: |
Noam Postavsky |
Subject: |
[Emacs-diffs] emacs-26 2b35ed0 8/8: Document external-debugging-output in the Elisp Manual (Bug#24051) |
Date: |
Tue, 30 Jan 2018 22:35:03 -0500 (EST) |
branch: emacs-26
commit 2b35ed0b0c49698337758004bd5e6062a3aaffab
Author: Noam Postavsky <address@hidden>
Commit: Noam Postavsky <address@hidden>
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.
---
doc/lispref/streams.texi | 23 ++++++++++++++++++++---
src/print.c | 2 +-
2 files changed, 21 insertions(+), 4 deletions(-)
diff --git a/doc/lispref/streams.texi b/doc/lispref/streams.texi
index bd7dc2d..6172392 100644
--- a/doc/lispref/streams.texi
+++ b/doc/lispref/streams.texi
@@ -503,7 +503,7 @@ in reverse order.
@end group
@group
-(print "This is the output" 'eat-output)
+(print "This is the output" #'eat-output)
@result{} "This is the output"
@end group
@@ -530,6 +530,22 @@ Now we can put the output in the proper order by reversing
the list:
Calling @code{concat} converts the list to a string so you can see its
contents more clearly.
address@hidden @code{stderr} stream, use for debugging
address@hidden
address@hidden external-debugging-output character
+This function can be useful as an output stream when debugging. It
+writes @var{character} to the standard error stream.
+
+For example
address@hidden
address@hidden
+(print "This is the output" #'external-debugging-output)
address@hidden This is the output
address@hidden "This is the output"
address@hidden group
address@hidden example
address@hidden defun
+
@node Output Functions
@section Output Functions
@@ -570,8 +586,9 @@ operation:
@end example
In the functions below, @var{stream} stands for an output stream.
-(See the previous section for a description of output streams.) If
address@hidden is @code{nil} or omitted, it defaults to the value of
+(See the previous section for a description of output streams. Also
address@hidden, a useful stream value for debugging.)
+If @var{stream} is @code{nil} or omitted, it defaults to the value of
@code{standard-output}.
@defun print object &optional stream
diff --git a/src/print.c b/src/print.c
index d140f99..af1e85f 100644
--- a/src/print.c
+++ b/src/print.c
@@ -748,7 +748,7 @@ is used instead. */)
DEFUN ("external-debugging-output", Fexternal_debugging_output,
Sexternal_debugging_output, 1, 1, 0,
doc: /* Write CHARACTER to stderr.
-You can call print while debugging emacs, and pass it this function
+You can call `print' while debugging emacs, and pass it this function
to make it write to the debugging output. */)
(Lisp_Object character)
{
- [Emacs-diffs] emacs-26 updated (4b5711b -> 2b35ed0), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 9e6889c 1/8: Emphasize that GPG passphrase caching is temporary (Bug#29907), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 f706c59 5/8: Update manual description of locate-file (Bug#23650), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 db6564c 7/8: Fix scroll-margin docstring (Bug#13791), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 607cc4e 2/8: Define cl-type-definition button type as needed (Bug#28899), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 53e9fa2 3/8: * lisp/custom.el (defcustom): Fix docstring (Bug#27891)., Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 1602262 4/8: Clarify effect of print-gensym (Bug#27776), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 732d1b9 6/8: Clarify that `ansi-term' is almost the same as `term' (Bug#18106), Noam Postavsky, 2018/01/30
- [Emacs-diffs] emacs-26 2b35ed0 8/8: Document external-debugging-output in the Elisp Manual (Bug#24051),
Noam Postavsky <=