From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#24051: 24.5; doc of `external-debugging-output' Date: Mon, 29 Jan 2018 19:14:01 +0200 Message-ID: <838tcgio4m.fsf@gnu.org> References: <871t2jyqj0.fsf@russet.org.uk> <87lgghk1q6.fsf@users.sourceforge.net> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1517246007 21667 195.159.176.226 (29 Jan 2018 17:13:27 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Mon, 29 Jan 2018 17:13:27 +0000 (UTC) Cc: 24051@debbugs.gnu.org, phillip.lord@russet.org.uk To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Jan 29 18:13:22 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1egCzf-00059A-5f for geb-bug-gnu-emacs@m.gmane.org; Mon, 29 Jan 2018 18:13:19 +0100 Original-Received: from localhost ([::1]:51907 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1egD1g-0007RS-1u for geb-bug-gnu-emacs@m.gmane.org; Mon, 29 Jan 2018 12:15:24 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:33524) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1egD1Q-0007KN-6S for bug-gnu-emacs@gnu.org; Mon, 29 Jan 2018 12:15:17 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1egD1K-0003k6-H2 for bug-gnu-emacs@gnu.org; Mon, 29 Jan 2018 12:15:08 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:40165) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1egD1K-0003jy-Cb for bug-gnu-emacs@gnu.org; Mon, 29 Jan 2018 12:15:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1egD1K-0008DU-6O for bug-gnu-emacs@gnu.org; Mon, 29 Jan 2018 12:15:02 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 29 Jan 2018 17:15:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 24051 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 24051-submit@debbugs.gnu.org id=B24051.151724604531507 (code B ref 24051); Mon, 29 Jan 2018 17:15:02 +0000 Original-Received: (at 24051) by debbugs.gnu.org; 29 Jan 2018 17:14:05 +0000 Original-Received: from localhost ([127.0.0.1]:48061 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1egD0P-0008C7-Ap for submit@debbugs.gnu.org; Mon, 29 Jan 2018 12:14:05 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:42278) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1egD0N-0008BX-OS for 24051@debbugs.gnu.org; Mon, 29 Jan 2018 12:14:04 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1egD0E-0003DK-BO for 24051@debbugs.gnu.org; Mon, 29 Jan 2018 12:13:58 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:33387) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1egD0E-0003DC-79; Mon, 29 Jan 2018 12:13:54 -0500 Original-Received: from [176.228.60.248] (port=1861 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1egD0D-0004bW-FW; Mon, 29 Jan 2018 12:13:54 -0500 In-reply-to: <87lgghk1q6.fsf@users.sourceforge.net> (message from Noam Postavsky on Sun, 28 Jan 2018 18:22:41 -0500) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 208.118.235.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:142657 Archived-At: > From: Noam Postavsky > 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.