From: Lars Ingebrigtsen <larsi@gnus.org>
To: Drew Adams <drew.adams@oracle.com>
Cc: 20737@debbugs.gnu.org
Subject: bug#20737: 25.0.50; doc of `process-file'
Date: Sat, 30 Apr 2016 21:52:55 +0200 [thread overview]
Message-ID: <87oa8qc1rc.fsf@gnus.org> (raw)
In-Reply-To: <0363f153-da92-4838-b581-9896fb99290b@default> (Drew Adams's message of "Thu, 4 Jun 2015 22:25:47 -0700 (PDT)")
Drew Adams <drew.adams@oracle.com> 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
next prev parent reply other threads:[~2016-04-30 19:52 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2015-06-05 5:25 bug#20737: 25.0.50; doc of `process-file' Drew Adams
2016-04-30 19:52 ` Lars Ingebrigtsen [this message]
2021-05-26 23:40 ` Lars Ingebrigtsen
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87oa8qc1rc.fsf@gnus.org \
--to=larsi@gnus.org \
--cc=20737@debbugs.gnu.org \
--cc=drew.adams@oracle.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.