From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Noam Postavsky Newsgroups: gmane.emacs.bugs Subject: bug#30349: 27.0.50; Cuonfusing documentation about pipe processes Date: Mon, 05 Feb 2018 19:53:12 -0500 Message-ID: <87zi4ndjlz.fsf@users.sourceforge.net> References: NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: blaine.gmane.org 1517878352 25938 195.159.176.226 (6 Feb 2018 00:52:32 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 6 Feb 2018 00:52:32 +0000 (UTC) User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.0.90 (gnu/linux) Cc: 30349@debbugs.gnu.org To: Philipp Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Feb 06 01:52:28 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 1eirUb-0005cl-GD for geb-bug-gnu-emacs@m.gmane.org; Tue, 06 Feb 2018 01:52:13 +0100 Original-Received: from localhost ([::1]:58908 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eirWa-00079p-SP for geb-bug-gnu-emacs@m.gmane.org; Mon, 05 Feb 2018 19:54:16 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:51738) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1eirWQ-00076k-5S for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 19:54:09 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1eirWM-00076V-HS for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 19:54:06 -0500 Original-Received: from debbugs.gnu.org ([208.118.235.43]:51347) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1eirWL-00074q-Uo for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 19:54:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1eirWL-0002bK-HR for bug-gnu-emacs@gnu.org; Mon, 05 Feb 2018 19:54:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: Noam Postavsky Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 06 Feb 2018 00:54:01 +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: Original-Received: via spool by 30349-submit@debbugs.gnu.org id=B30349.15178784079955 (code B ref 30349); Tue, 06 Feb 2018 00:54:01 +0000 Original-Received: (at 30349) by debbugs.gnu.org; 6 Feb 2018 00:53:27 +0000 Original-Received: from localhost ([127.0.0.1]:59244 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eirVk-0002aO-SY for submit@debbugs.gnu.org; Mon, 05 Feb 2018 19:53:27 -0500 Original-Received: from mail-it0-f44.google.com ([209.85.214.44]:37151) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1eirVh-0002a2-DX; Mon, 05 Feb 2018 19:53:21 -0500 Original-Received: by mail-it0-f44.google.com with SMTP id h129so474364ita.2; Mon, 05 Feb 2018 16:53:21 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=sender:from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=FrldbIbsi9Z3iVb6D/yLzFXcGXTrlzw6AqzLoOcG0A4=; b=vfzrkX/i30RrgdHEPTLDumewE401at/+NdmicCUpZ+OzOWViM2569b0LPJIxhV2rFz 2s8uqc7bxTvQ8pG4aYORCqabdcj4KOrr7mfNV1nCPAo7tdcttAKfhRpe93OLCrtJpQQE /lIbF9oQXWcSNstKdIWvLB7sTIrMqqjNn52+HaNeiwRYCsQWWoDxAu60/YeT+pLaK+fd 5783i/D/MSLHuv+8OH7IJWnncPHMQtvJVXVgXH5W7O6Z8SxC3tKIiojU1TpD1cSSg0WU hqB3qR4Mgw4P8/JOM+Vc9QrHh5PVi4waxXupNzEHUOWdjJGp7YgVNuowXmrlXErMui9t Ukeg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:sender:from:to:cc:subject:references:date :in-reply-to:message-id:user-agent:mime-version; bh=FrldbIbsi9Z3iVb6D/yLzFXcGXTrlzw6AqzLoOcG0A4=; b=IBj5bbkTV+6vDFZLLB3k9BC/H7aCP6tPYNkfP9PGgrcCnLYc+IxEdifVf+BpzdSSVP O/UCk75G5uoHAlZDFmRp6ducaW5z5qjk6stek4MCWRJf6azBtFxLNQkEO1fs4AR9wN4A /CZYOf3b9TMJjpb7/S3mB1f2CLBotrkgzEX0y2P/dV6gN03imz3WuQ0pLoSM7p6md7u6 H2Rz4mXmLnMEySIi1o2nsYQ6CV6PShazxxoL/hqwl0R/qeaC0JLvhjNl00R1DQN7JpzO LIYn76Lp0evC5q8omz32IRygGusxBS3Ux7LyySviC62IHB8bQw7J/d2rp4XjMEFvUxgu HfKA== X-Gm-Message-State: APf1xPDyavagokA+p76uCIXdjEBlsNV+nt1hlZ8oUDdAJgxheAJLuvtI abQrj23gcJmAjkufbMkmw+cvMw== X-Google-Smtp-Source: AH8x2276mlNUhAIEUaoyd0iHffAhSUa+gzHr3hTmmHT1DEcoioPydoUn48ulnfQDZVlJ44xq+CbWbg== X-Received: by 10.36.13.5 with SMTP id 5mr859415itx.68.1517878395626; Mon, 05 Feb 2018 16:53:15 -0800 (PST) Original-Received: from zebian (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34]) by smtp.googlemail.com with ESMTPSA id c9sm6066531iod.5.2018.02.05.16.53.13 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Mon, 05 Feb 2018 16:53:13 -0800 (PST) In-Reply-To: (Philipp's message of "Sun, 04 Feb 2018 17:29:30 +0100") 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:142958 Archived-At: --=-=-= Content-Type: text/plain tags 30349 + patch quit Philipp writes: > C-h f make-pipe-process says: > > ":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. > The manual says about pipe processes: > > @item :stop @var{stopped} > If @var{stopped} is non-@code{nil}, start the process in the > stopped state. > > => What does "the stopped state" mean? How can a pipe be "stopped"? The docstring explains it fine, may as well copy that part to the manual I guess. --=-=-= Content-Type: text/x-diff Content-Disposition: inline; filename=v1-0001-Doc-fixes-for-process-functions-Bug-30349.patch Content-Description: patch >From 902ded87cb2e8079259c34a323afa84b11f84e8b Mon Sep 17 00:00:00 2001 From: Noam Postavsky Date: Mon, 5 Feb 2018 19:36:27 -0500 Subject: [PATCH v1] Doc fixes for process functions (Bug#30349) * doc/lispref/processes.texi (Asynchronous Processes): Explain what the 'stopped' state means for a pipe process. * src/process.c (Fmake_process, Fmake_pipe_process) (Fmake_serial_process, Fmake_network_process): Remove meaningless phrase "specify an output stream" from docstring. --- doc/lispref/processes.texi | 6 ++++-- src/process.c | 26 ++++++++++++-------------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/lispref/processes.texi b/doc/lispref/processes.texi index 8a8425cb84..4706a9daa0 100644 --- a/doc/lispref/processes.texi +++ b/doc/lispref/processes.texi @@ -728,8 +728,10 @@ Asynchronous Processes @xref{Query Before Exit}. @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}. @item :filter @var{filter} Initialize the process filter to @var{filter}. If not specified, a diff --git a/src/process.c b/src/process.c index 8a438cfeb8..e688510a41 100644 --- a/src/process.c +++ b/src/process.c @@ -1617,10 +1617,9 @@ DEFUN ("make-process", Fmake_process, Smake_process, 0, MANY, 0, to make it unique. :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. :command COMMAND -- COMMAND is a list starting with the program file name, followed by strings to give to the program as arguments. @@ -2309,9 +2308,9 @@ DEFUN ("make-pipe-process", Fmake_pipe_process, Smake_pipe_process, :name NAME -- NAME is the name of the process. It is modified if necessary to make it unique. :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. If BUFFER is not given, the value of NAME is used. +with the process. The default filter function writes process output +at the end of that buffer. If BUFFER is not given, the value of NAME +is used. :coding CODING -- If CODING is a symbol, it specifies the coding system used for both reading and writing for this process. If CODING @@ -3024,9 +3023,9 @@ DEFUN ("make-serial-process", Fmake_serial_process, Smake_serial_process, the value of PORT is used. :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. If BUFFER is not given, the value of NAME is used. +with the process. The default filter function writes process output +at the end of that buffer. If BUFFER is not given, the value of NAME +is used. :coding CODING -- If CODING is a symbol, it specifies the coding system used for both reading and writing for this process. If CODING @@ -3687,10 +3686,9 @@ DEFUN ("make-network-process", Fmake_network_process, Smake_network_process, to make it unique. :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. :host HOST -- HOST is name of the host to connect to, or its IP address. The symbol `local' specifies the local host. If specified -- 2.11.0 --=-=-=--