From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Lars Ingebrigtsen Newsgroups: gmane.emacs.bugs Subject: bug#20737: 25.0.50; doc of `process-file' Date: Sat, 30 Apr 2016 21:52:55 +0200 Message-ID: <87oa8qc1rc.fsf@gnus.org> References: <0363f153-da92-4838-b581-9896fb99290b@default> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain X-Trace: ger.gmane.org 1462046023 18443 80.91.229.3 (30 Apr 2016 19:53:43 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Sat, 30 Apr 2016 19:53:43 +0000 (UTC) Cc: 20737@debbugs.gnu.org To: Drew Adams Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Apr 30 21:53:31 2016 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1awaxF-0004wg-IV for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 21:53:29 +0200 Original-Received: from localhost ([::1]:59476 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awaxB-0002Uy-RT for geb-bug-gnu-emacs@m.gmane.org; Sat, 30 Apr 2016 15:53:25 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:59180) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awax3-0002IN-EA for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:53:23 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1awawr-0006ek-JC for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:53:11 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:46157) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1awawr-0006dp-FG for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:53:05 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1awawn-0001ia-UT for bug-gnu-emacs@gnu.org; Sat, 30 Apr 2016 15:53:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Lars Ingebrigtsen Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 30 Apr 2016 19:53:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 20737 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: Original-Received: via spool by 20737-submit@debbugs.gnu.org id=B20737.14620459806595 (code B ref 20737); Sat, 30 Apr 2016 19:53:01 +0000 Original-Received: (at 20737) by debbugs.gnu.org; 30 Apr 2016 19:53:00 +0000 Original-Received: from localhost ([127.0.0.1]:58494 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awawm-0001iJ-8x for submit@debbugs.gnu.org; Sat, 30 Apr 2016 15:53:00 -0400 Original-Received: from hermes.netfonds.no ([80.91.224.195]:60079) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1awawl-0001iB-Aa for 20737@debbugs.gnu.org; Sat, 30 Apr 2016 15:52:59 -0400 Original-Received: from cm-84.215.1.64.getinternet.no ([84.215.1.64] helo=mouse) by hermes.netfonds.no with esmtpsa (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.84_2) (envelope-from ) id 1awawi-0006A5-2z; Sat, 30 Apr 2016 21:52:58 +0200 In-Reply-To: <0363f153-da92-4838-b581-9896fb99290b@default> (Drew Adams's message of "Thu, 4 Jun 2015 22:25:47 -0700 (PDT)") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux) 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:117439 Archived-At: Drew Adams writes: > The parameters are not described correctly. > > This is the complete description/explanation of INFILE and BUFFER: > > File names in INFILE and BUFFER are handled normally, but file > names in ARGS should be relative to `default-directory', as they > are passed to the process verbatim. (This is a difference to > `call-process' which does not support file handlers for INFILE > and BUFFER.) > > What does that even mean? One might deduce that INFILE, BUFFER, and > ARGS are lists that can contain file names (and perhaps other stuff), > but that's about all. What their structure is or what they are for are > completely unknown. > > And this is all that is said about parameter DISPLAY: > > Some file handlers might not support all variants, for example > they might behave as if DISPLAY was nil, regardless of the actual > value passed. > > That tells you less than nothing. > > This is really useless doc. Please do something to document > `process-file' properly. `process-file' seems to be a shim over `call-process', but: ---- Similar to `call-process', but may invoke a file handler based on `default-directory'. The current working directory of the subprocess is `default-directory'. ---- I think the rest of the doc string tries to say what's different in the arguments between `process-file' and `call-process', but it kinda fails at doing that. Especially since ARGS and DISPLAY are just passed on to `call-process' verbatim in the default case. So somebody who knows what this function is meant to be doing (I've never heard of it before now) should take another crack at writing a new doc string. -- (domestic pets only, the antidote for overdose, milk.) bloggy blog: http://lars.ingebrigtsen.no