GNU bug report logs - #20737
25.0.50; doc of `process-file'

Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.

Package: emacs; Severity: minor; Reported by: Drew Adams <drew.adams@HIDDEN>; dated Fri, 5 Jun 2015 05:27:02 UTC; Maintainer for emacs is bug-gnu-emacs@HIDDEN.

Message received at 20737 <at> debbugs.gnu.org:


Received: (at 20737) by debbugs.gnu.org; 30 Apr 2016 19:53:00 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Sat Apr 30 15:53:00 2016
Received: from localhost ([127.0.0.1]:58494 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.84_2)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1awawm-0001iJ-8x
	for submit <at> debbugs.gnu.org; Sat, 30 Apr 2016 15:53:00 -0400
Received: from hermes.netfonds.no ([80.91.224.195]:60079)
 by debbugs.gnu.org with esmtp (Exim 4.84_2)
 (envelope-from <larsi@HIDDEN>) id 1awawl-0001iB-Aa
 for 20737 <at> debbugs.gnu.org; Sat, 30 Apr 2016 15:52:59 -0400
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 <larsi@HIDDEN>)
 id 1awawi-0006A5-2z; Sat, 30 Apr 2016 21:52:58 +0200
From: Lars Ingebrigtsen <larsi@HIDDEN>
To: Drew Adams <drew.adams@HIDDEN>
Subject: Re: bug#20737: 25.0.50; doc of `process-file'
References: <0363f153-da92-4838-b581-9896fb99290b@default>
Date: Sat, 30 Apr 2016 21:52:55 +0200
In-Reply-To: <0363f153-da92-4838-b581-9896fb99290b@default> (Drew Adams's
 message of "Thu, 4 Jun 2015 22:25:47 -0700 (PDT)")
Message-ID: <87oa8qc1rc.fsf@HIDDEN>
User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/25.1.50 (gnu/linux)
MIME-Version: 1.0
Content-Type: text/plain
X-Spam-Score: 0.0 (/)
X-Debbugs-Envelope-To: 20737
Cc: 20737 <at> debbugs.gnu.org
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.18
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: 0.0 (/)

Drew Adams <drew.adams@HIDDEN> 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




Information forwarded to bug-gnu-emacs@HIDDEN:
bug#20737; Package emacs. Full text available.

Message received at submit <at> debbugs.gnu.org:


Received: (at submit) by debbugs.gnu.org; 5 Jun 2015 05:26:06 +0000
From debbugs-submit-bounces <at> debbugs.gnu.org Fri Jun 05 01:26:06 2015
Received: from localhost ([127.0.0.1]:40963 helo=debbugs.gnu.org)
	by debbugs.gnu.org with esmtp (Exim 4.80)
	(envelope-from <debbugs-submit-bounces <at> debbugs.gnu.org>)
	id 1Z0k8r-00076B-EZ
	for submit <at> debbugs.gnu.org; Fri, 05 Jun 2015 01:26:06 -0400
Received: from eggs.gnu.org ([208.118.235.92]:36784)
 by debbugs.gnu.org with esmtp (Exim 4.80)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8o-00075f-0g
 for submit <at> debbugs.gnu.org; Fri, 05 Jun 2015 01:26:02 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8h-0006IJ-O4
 for submit <at> debbugs.gnu.org; Fri, 05 Jun 2015 01:25:56 -0400
X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org
X-Spam-Level: 
X-Spam-Status: No, score=-0.0 required=5.0 tests=BAYES_40 autolearn=disabled
 version=3.3.2
Received: from lists.gnu.org ([2001:4830:134:3::11]:34801)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8h-0006IF-LI
 for submit <at> debbugs.gnu.org; Fri, 05 Jun 2015 01:25:55 -0400
Received: from eggs.gnu.org ([2001:4830:134:3::10]:50287)
 by lists.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8g-0000FT-Je
 for bug-gnu-emacs@HIDDEN; Fri, 05 Jun 2015 01:25:55 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8d-0006HX-DW
 for bug-gnu-emacs@HIDDEN; Fri, 05 Jun 2015 01:25:54 -0400
Received: from userp1040.oracle.com ([156.151.31.81]:19146)
 by eggs.gnu.org with esmtp (Exim 4.71)
 (envelope-from <drew.adams@HIDDEN>) id 1Z0k8d-0006HO-6S
 for bug-gnu-emacs@HIDDEN; Fri, 05 Jun 2015 01:25:51 -0400
Received: from aserv0021.oracle.com (aserv0021.oracle.com [141.146.126.233])
 by userp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id
 t555Pmte014937
 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK)
 for <bug-gnu-emacs@HIDDEN>; Fri, 5 Jun 2015 05:25:49 GMT
Received: from userv0122.oracle.com (userv0122.oracle.com [156.151.31.75])
 by aserv0021.oracle.com (8.13.8/8.13.8) with ESMTP id t555PmfV032371
 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=FAIL)
 for <bug-gnu-emacs@HIDDEN>; Fri, 5 Jun 2015 05:25:48 GMT
Received: from abhmp0003.oracle.com (abhmp0003.oracle.com [141.146.116.9])
 by userv0122.oracle.com (8.13.8/8.13.8) with ESMTP id t555Pl0x018160
 for <bug-gnu-emacs@HIDDEN>; Fri, 5 Jun 2015 05:25:47 GMT
MIME-Version: 1.0
Message-ID: <0363f153-da92-4838-b581-9896fb99290b@default>
Date: Thu, 4 Jun 2015 22:25:47 -0700 (PDT)
From: Drew Adams <drew.adams@HIDDEN>
To: bug-gnu-emacs@HIDDEN
Subject: 25.0.50; doc of `process-file'
X-Priority: 3
X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9  (901082) [OL
 12.0.6691.5000 (x86)]
Content-Type: text/plain; charset=us-ascii
Content-Transfer-Encoding: quoted-printable
X-Source-IP: aserv0021.oracle.com [141.146.126.233]
X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.4.x-2.6.x [generic]
X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address
 (bad octet value).
X-Received-From: 2001:4830:134:3::11
X-Spam-Score: -4.0 (----)
X-Debbugs-Envelope-To: submit
X-BeenThere: debbugs-submit <at> debbugs.gnu.org
X-Mailman-Version: 2.1.15
Precedence: list
List-Id: <debbugs-submit.debbugs.gnu.org>
List-Unsubscribe: <https://debbugs.gnu.org/cgi-bin/mailman/options/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=unsubscribe>
List-Archive: <https://debbugs.gnu.org/cgi-bin/mailman/private/debbugs-submit/>
List-Post: <mailto:debbugs-submit <at> debbugs.gnu.org>
List-Help: <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=help>
List-Subscribe: <https://debbugs.gnu.org/cgi-bin/mailman/listinfo/debbugs-submit>, 
 <mailto:debbugs-submit-request <at> debbugs.gnu.org?subject=subscribe>
Errors-To: debbugs-submit-bounces <at> debbugs.gnu.org
Sender: "Debbugs-submit" <debbugs-submit-bounces <at> debbugs.gnu.org>
X-Spam-Score: -4.0 (----)

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.


In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-20 on LEG570
Bzr revision: 118168 rgm@HIDDEN
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=3Dyes,glyphs CPPFLAGS=3D-DGLYPH_DEBUG=3D1'




Acknowledgement sent to Drew Adams <drew.adams@HIDDEN>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs@HIDDEN. Full text available.
Report forwarded to bug-gnu-emacs@HIDDEN:
bug#20737; Package emacs. Full text available.
Please note: This is a static page, with minimal formatting, updated once a day.
Click here to see this page with the latest information and nicer formatting.
Last modified: Sat, 30 Apr 2016 20:00:02 UTC

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997 nCipher Corporation Ltd, 1994-97 Ian Jackson.