unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 20737@debbugs.gnu.org
Subject: bug#20737: 25.0.50; doc of `process-file'
Date: Thu, 4 Jun 2015 22:25:47 -0700 (PDT)	[thread overview]
Message-ID: <0363f153-da92-4838-b581-9896fb99290b@default> (raw)

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@gnu.org-20141020195941-icp42t8ttcnud09g
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs CPPFLAGS=-DGLYPH_DEBUG=1'





             reply	other threads:[~2015-06-05  5:25 UTC|newest]

Thread overview: 3+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2015-06-05  5:25 Drew Adams [this message]
2016-04-30 19:52 ` bug#20737: 25.0.50; doc of `process-file' Lars Ingebrigtsen
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

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=0363f153-da92-4838-b581-9896fb99290b@default \
    --to=drew.adams@oracle.com \
    --cc=20737@debbugs.gnu.org \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).