From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Drew Adams Newsgroups: gmane.emacs.devel Subject: RE: async-shell-command Date: Mon, 18 Apr 2016 13:09:59 -0700 (PDT) Message-ID: <7550baf5-1d20-4f87-83bb-1fd4b3408292@default> References: <87a8kuugyb.fsf@mbork.pl> <87k2jubsih.fsf@mbork.pl> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1461010231 25833 80.91.229.3 (18 Apr 2016 20:10:31 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 18 Apr 2016 20:10:31 +0000 (UTC) Cc: emacs-devel To: Marcin Borkowski , John Wiegley Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Apr 18 22:10:18 2016 Return-path: Envelope-to: ged-emacs-devel@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 1asFUv-0004IG-IN for ged-emacs-devel@m.gmane.org; Mon, 18 Apr 2016 22:10:17 +0200 Original-Received: from localhost ([::1]:44726 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asFUu-0002Sm-Pr for ged-emacs-devel@m.gmane.org; Mon, 18 Apr 2016 16:10:16 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:57864) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asFUr-0002Qr-7A for emacs-devel@gnu.org; Mon, 18 Apr 2016 16:10:14 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1asFUn-0003nQ-7c for emacs-devel@gnu.org; Mon, 18 Apr 2016 16:10:13 -0400 Original-Received: from aserp1040.oracle.com ([141.146.126.69]:39899) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1asFUn-0003nK-2A for emacs-devel@gnu.org; Mon, 18 Apr 2016 16:10:09 -0400 Original-Received: from aserv0021.oracle.com (aserv0021.oracle.com [141.146.126.233]) by aserp1040.oracle.com (Sentrion-MTA-4.3.2/Sentrion-MTA-4.3.2) with ESMTP id u3IKA55M032233 (version=TLSv1 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 18 Apr 2016 20:10:05 GMT Original-Received: from aserv0121.oracle.com (aserv0121.oracle.com [141.146.126.235]) by aserv0021.oracle.com (8.13.8/8.13.8) with ESMTP id u3IKA56L007304 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=OK); Mon, 18 Apr 2016 20:10:05 GMT Original-Received: from abhmp0016.oracle.com (abhmp0016.oracle.com [141.146.116.22]) by aserv0121.oracle.com (8.13.8/8.13.8) with ESMTP id u3IK9xoa006128; Mon, 18 Apr 2016 20:10:04 GMT In-Reply-To: <87k2jubsih.fsf@mbork.pl> X-Priority: 3 X-Mailer: Oracle Beehive Extensions for Outlook 2.0.1.9 (901082) [OL 12.0.6744.5000 (x86)] 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-Received-From: 141.146.126.69 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:203072 Archived-At: > Also, I'm pretty sure that the current meaning of the prefix argument > for `async-shell-command' /must/ be documented - it is far from obvious, > and can be learned only from careful reading of the code. You need not read the code, but you do need to read the doc string carefully. The info about the arguments is available, but not clearly and directly. For `async-shell-command' the doc string says: "Like `shell-command', but..." But like it in what ways, one might wonder? In fact and in particular, it is like `shell-command' wrt the arguments. It would be better for this doc string to explicitly refer a reader to the doc string of `shell-command' for info about the arguments, including the use of a prefix arg. > I'm going to prepare such a patch for docs (both the docstring > and the manual) first. Thank you. I'm sure it will be an improvement. (Note too that the second line of the doc string should not be blank. Dunno why some people seem to think it is right to add such a line. I suspect that it comes from reading the doc string only in the Lisp source instead of trying `C-h f'.)