unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Noam Postavsky <npostavs@users.sourceforge.net>
Cc: p.stephani2@gmail.com, 30349@debbugs.gnu.org
Subject: bug#30349: 27.0.50; Cuonfusing documentation about pipe processes
Date: Tue, 06 Feb 2018 05:54:43 +0200	[thread overview]
Message-ID: <83tvuu7oxo.fsf@gnu.org> (raw)
In-Reply-To: <87zi4ndjlz.fsf@users.sourceforge.net> (message from Noam Postavsky on Mon, 05 Feb 2018 19:53:12 -0500)

> From: Noam Postavsky <npostavs@users.sourceforge.net>
> Date: Mon, 05 Feb 2018 19:53:12 -0500
> Cc: 30349@debbugs.gnu.org
> 
> > ":buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
> > with the process.  Process output goes at the end of that buffer,
> > unless you specify an output stream or filter function to handle the
> > output."
> >
> > => How do you specify an output stream?
> 
> I don't think there is such a thing.  That phrase seems to have been
> copied across all the make-*-process functions.

And is wrong in all of them?

Could it be that the phrase originally meant shell-style redirection?

>  @item :stop @var{stopped}
> -If @var{stopped} is non-@code{nil}, start the process in the
> -stopped state.
> +If @var{stopped} is non-@code{nil}, start the process in the stopped
> +state.  In the stopped state, a pipe process does not accept incoming
> +data, but you can send outgoing data.  The stopped state is cleared by
> +@code{continue-process} and set by @code{stop-process}.

In the last sentence, I'd swap the order of references to clearing and
setting the stopped state.  I'd also add a @pxref to where those two
functions are described.

>  :buffer BUFFER -- BUFFER is the buffer (or buffer-name) to associate
> -with the process.  Process output goes at end of that buffer, unless
> -you specify an output stream or filter function to handle the output.
> -BUFFER may be also nil, meaning that this process is not associated
> -with any buffer.
> +with the process.  The default filter function writes process output
> +at the end of that buffer.  BUFFER may be also nil, meaning that this
> +process is not associated with any buffer.

This goes too far in deleting stuff that is useful: the part of the
second sentence that follows "unless", which talks about specifying a
filter function, should be left alone.  Without it, "The default
filter function ..." surprises the reader, since it talks about the
default of something that wasn't mentioned before.

With those fixed, this is good for the release branch, thanks.





  reply	other threads:[~2018-02-06  3:54 UTC|newest]

Thread overview: 11+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-02-04 16:29 bug#30349: 27.0.50; Cuonfusing documentation about pipe processes Philipp
2018-02-04 17:46 ` Eli Zaretskii
2018-02-06  0:53 ` Noam Postavsky
2018-02-06  3:54   ` Eli Zaretskii [this message]
2018-02-06 12:10     ` Noam Postavsky
2018-02-06 16:31       ` Basil L. Contovounesios
2018-02-06 16:44         ` Noam Postavsky
2018-02-06 18:55       ` Eli Zaretskii
2018-02-07  0:05         ` Noam Postavsky
2018-02-07  3:40           ` Eli Zaretskii
2018-02-08  1:24           ` Noam Postavsky

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=83tvuu7oxo.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=30349@debbugs.gnu.org \
    --cc=npostavs@users.sourceforge.net \
    --cc=p.stephani2@gmail.com \
    /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).