unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
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 06:47:10 -0800 (PST)	[thread overview]
Message-ID: <bf7223d4-212a-417f-a39b-8835e2778168@default> (raw)
In-Reply-To: <878tchjyvh.fsf@users.sourceforge.net>

> > And it might be good to add an example that shows use of it,
> > e.g., with `print'.
> 
> Something like this?  I'm not sure if this example really adds much.
> 
> (Also not entirely sure about how the texinfo markup should be for
> this.)
> 
>     For example
>     @example
>     (print "This is the output #'external-debugging-output)
>     @end example
>     would print @samp{This is the output} to standard error.

Yes, I think so (I can't speak to the texinfo markup either).

---

But I do wonder how we should talk about the standard error
stream.  I see only one other occurrence of "standard error"
where it means the stream (and not the discussion of standard
Emacs errors), and there it is referred to the same way.  So
I guess that's the right way to refer to it in our docs.

On the other hand, would it be good to say something about
the streams (the terms) "standard output" and "standard error"
in node `Output Streams'?  We refer to both (especially the
former) in various places, but we don't say what those names
mean.  For a UNIX or GNU/Linux user such terms are well known,
but is that to be assumed about everyone reading the Elisp
manual?  Just a thought/question.

Actually, in `Output Streams' we do kind of say what is
meant by "standard output", by describing variable
`standard-output':

  that value is the "default output stream"

Using that short description not just for the value of
variable `standard-output' but also for the term "standard
output" would be helpful.  Similarly for "standard error":
some such brief description would help.

In node `Output Streams' and in other nodes we refer to the
variable `standard-output'.  I think it would help to use
the word "variable" before that - e.g.:

  'nil' specified as an output stream means to use the value of
  variable 'standard-output' instead; that value is the "default
  ^^^^^^^^
  output stream", and must not be 'nil'.

Yes, it should be clear from "value of", but it would be
clearer still with "variable".  Also, the next line describes
SYMBOL, and there the use is as a function name. 

Similarly, in other places where we mention `standard-output'.
It wouldn't hurt to make clear that it is a (global) variable.






  reply	other threads:[~2018-01-29 14:47 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 [this message]
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

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=bf7223d4-212a-417f-a39b-8835e2778168@default \
    --to=drew.adams@oracle.com \
    --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 public inbox

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

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).