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#30349: 27.0.50; Cuonfusing documentation about pipe processes Date: Tue, 06 Feb 2018 05:54:43 +0200 Message-ID: <83tvuu7oxo.fsf@gnu.org> References: <87zi4ndjlz.fsf@users.sourceforge.net> Reply-To: Eli Zaretskii NNTP-Posting-Host: blaine.gmane.org X-Trace: blaine.gmane.org 1517889267 27701 195.159.176.226 (6 Feb 2018 03:54:27 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Feb 2018 03:54:27 +0000 (UTC) Cc: p.stephani2@gmail.com, 30349@debbugs.gnu.org To: Noam Postavsky Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Feb 06 04:54:23 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 1eiuKc-0005xp-QQ for geb-bug-gnu-emacs@m.gmane.org; Tue, 06 Feb 2018 04:54:06 +0100 Original-Received: from localhost ([::1]:47719 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eiuMe-00010I-1B for geb-bug-gnu-emacs@m.gmane.org; Mon, 05 Feb 2018 22:56:12 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:40110) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eiuMX-0000zj-SO for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 22:56:06 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eiuMU-0000pC-Nx for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 22:56:05 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51483) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eiuMU-0000p5-Je for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 22:56:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eiuMU-0002XT-79 for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 22:56: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: Tue, 06 Feb 2018 03:56:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 30349 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch Original-Received: via spool by 30349-submit@debbugs.gnu.org id=B30349.15178893029676 (code B ref 30349); Tue, 06 Feb 2018 03:56:02 +0000 Original-Received: (at 30349) by debbugs.gnu.org; 6 Feb 2018 03:55:02 +0000 Original-Received: from localhost ([127.0.0.1]:59380 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eiuLV-0002Vx-QU for submit@debbugs.gnu.org; Mon, 05 Feb 2018 22:55:02 -0500 Original-Received: from eggs.gnu.org ([208.118.235.92]:48978) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eiuLU-0002VZ-Hc for 30349@debbugs.gnu.org; Mon, 05 Feb 2018 22:55:00 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eiuLK-0008Uh-NU for 30349@debbugs.gnu.org; Mon, 05 Feb 2018 22:54:55 -0500 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:35114) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eiuLK-0008Ud-JS; Mon, 05 Feb 2018 22:54:50 -0500 Original-Received: from [176.228.60.248] (port=4815 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1eiuLK-0002Xj-2i; Mon, 05 Feb 2018 22:54:50 -0500 In-reply-to: <87zi4ndjlz.fsf@users.sourceforge.net> (message from Noam Postavsky on Mon, 05 Feb 2018 19:53:12 -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:142962 Archived-At: > From: Noam Postavsky > 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.