all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Noam Postavsky <npostavs@users.sourceforge.net>
Cc: 24051@debbugs.gnu.org, phillip.lord@russet.org.uk
Subject: bug#24051: 24.5; doc of `external-debugging-output'
Date: Mon, 29 Jan 2018 19:14:01 +0200	[thread overview]
Message-ID: <838tcgio4m.fsf@gnu.org> (raw)
In-Reply-To: <87lgghk1q6.fsf@users.sourceforge.net> (message from Noam Postavsky on Sun, 28 Jan 2018 18:22:41 -0500)

> From: Noam Postavsky <npostavs@users.sourceforge.net>
> Date: Sun, 28 Jan 2018 18:22:41 -0500
> Cc: 24051@debbugs.gnu.org
> 
> I don't think it fits under "Output Functions" though, as it says:
> 
>     This section describes the Lisp functions for printing Lisp
>     objects--converting objects into their printed representation.
> 
> It's rather an example of an output stream, so it should go in the
> previous section:

But you can also mention it there, with a cross-reference.

> --- a/doc/lispref/streams.texi
> +++ b/doc/lispref/streams.texi
> @@ -530,6 +530,12 @@ Output Streams
>  Calling @code{concat} converts the list to a string so you can see its
>  contents more clearly.
>  
> +@findex stderr

stderr is not a function, so @findex is not appropriate for it.  I'd
rather suggest this:

  @cindex @code{stderr} stream, use for debugging

> +@defun external-debugging-output character
> +This function can be useful as an output stream when debugging.  It
> +writes @var{character} to the standard error stream.
> +@end defun

Thanks, this is good for the release branch.





      parent reply	other threads:[~2018-01-29 17:14 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-07-22 16:01 bug#24051: 24.5; doc of `external-debugging-output' Drew Adams
2016-07-24 16:00 ` Phillip Lord
2018-01-28 23:22   ` Noam Postavsky
2018-01-28 23:49     ` Drew Adams
2018-01-29  0:24       ` Noam Postavsky
2018-01-29 14:47         ` Drew Adams
2018-01-30 13:52           ` Eli Zaretskii
2018-01-29 17:26         ` Eli Zaretskii
2018-01-30  0:38           ` Noam Postavsky
2018-01-30  8:22             ` Michael Albinus
2018-01-30 13:29               ` Eli Zaretskii
2018-01-30 14:00             ` Eli Zaretskii
2018-01-31  3:43               ` Noam Postavsky
     [not found]                 ` <87a7wtkecz.fsf@russet.org.uk>
2018-01-31 19:38                   ` Phillip Lord
     [not found]         ` <<bf7223d4-212a-417f-a39b-8835e2778168@default>
     [not found]           ` <<83k1vzh2rq.fsf@gnu.org>
2018-01-30 15:09             ` Drew Adams
2018-01-29 17:14     ` Eli Zaretskii [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=838tcgio4m.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=24051@debbugs.gnu.org \
    --cc=npostavs@users.sourceforge.net \
    --cc=phillip.lord@russet.org.uk \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.