From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Damien Cassou Newsgroups: gmane.emacs.bugs Subject: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command Date: Tue, 17 Apr 2018 13:39:33 +0200 Message-ID: <87o9iijc3u.fsf@cassou.me> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" X-Trace: blaine.gmane.org 1523965091 27346 195.159.176.226 (17 Apr 2018 11:38:11 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Tue, 17 Apr 2018 11:38:11 +0000 (UTC) To: 31191@debbugs.gnu.org Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Tue Apr 17 13:38:06 2018 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Ovz-0006zY-Or for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 13:38:04 +0200 Original-Received: from localhost ([::1]:33007 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8Oy6-0004d3-GM for geb-bug-gnu-emacs@m.gmane.org; Tue, 17 Apr 2018 07:40:14 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48028) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8Oxz-0004cf-Jn for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:40:08 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8Oxv-0007Wd-NQ for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:40:07 -0400 Original-Received: from debbugs.gnu.org ([208.118.235.43]:48870) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1f8Oxv-0007WV-Jk for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:40:03 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1f8Oxv-0003U9-4Q for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:40:03 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Damien Cassou Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Tue, 17 Apr 2018 11:40:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 31191 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: patch X-Debbugs-Original-To: bug-gnu-emacs@gnu.org Original-Received: via spool by submit@debbugs.gnu.org id=B.152396520113384 (code B ref -1); Tue, 17 Apr 2018 11:40:02 +0000 Original-Received: (at submit) by debbugs.gnu.org; 17 Apr 2018 11:40:01 +0000 Original-Received: from localhost ([127.0.0.1]:56767 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Oxt-0003To-BQ for submit@debbugs.gnu.org; Tue, 17 Apr 2018 07:40:01 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:56920) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Oxr-0003TZ-BW for submit@debbugs.gnu.org; Tue, 17 Apr 2018 07:39:59 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8Oxl-0007RA-9M for submit@debbugs.gnu.org; Tue, 17 Apr 2018 07:39:54 -0400 Original-Received: from lists.gnu.org ([2001:4830:134:3::11]:56079) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1f8Oxl-0007Qx-5T for submit@debbugs.gnu.org; Tue, 17 Apr 2018 07:39:53 -0400 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:47848) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1f8Oxk-0004Xf-1I for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:39:52 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1f8Oxg-0007Oo-3p for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:39:52 -0400 Original-Received: from mail.choca.pics ([62.210.108.126]:51982) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1f8Oxf-0007Jc-PR for bug-gnu-emacs@gnu.org; Tue, 17 Apr 2018 07:39:48 -0400 Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id DE1462324053 for ; Tue, 17 Apr 2018 13:39:38 +0200 (CEST) Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id c3Taa502rdi0 for ; Tue, 17 Apr 2018 13:39:37 +0200 (CEST) Original-Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id BC6CD23240A6 for ; Tue, 17 Apr 2018 13:39:37 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics BC6CD23240A6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1523965177; bh=510uwENsS7vYk/vlF12Jvtu9166d8obifaItX/tV8Zo=; h=From:To:Date:Message-ID:MIME-Version; b=GWJFTu1xVADjvQCjZ1YyWyk6peY8qNuFmKH9v8qRNwjFP0jIuuYjw/dFxxOgt7hwn Qlr8gixuuyAlusgM1BUKGfqx0sBJnJmmsuPkJwqKENfPXy2H2kwYnaPlXC2c2N9UM3 SmBdzVyEifeoHLjtVPyjBudhYeFOrd+z8JJPBzzqBp6nDHlsVOr2hn3Hs7R2TyeWgF r5vnEAMjKgN5WZWmV89jCceuV5NzieDVdmwOq5fSv9DKrazz3G5uRPYoPNCBLFwT6U sZn77/nEF0Dz4zupwBZw0sBRXW15zvPF8CznSQrc7l9ARMK5LrqCD6ZSw+dNaXZw7T lVf976vq33E/g== X-Virus-Scanned: amavisd-new at choca.pics Original-Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id up8qUQDwOp3U for ; Tue, 17 Apr 2018 13:39:37 +0200 (CEST) Original-Received: from luz4 (unknown [IPv6:2a00:5884:8368:0:981a:1b8d:5415:a323]) by mail.choca.pics (Postfix) with ESMTPSA id 66BC32324053 for ; Tue, 17 Apr 2018 13:39:37 +0200 (CEST) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.6.x 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:145479 Archived-At: --=-=-= Content-Type: text/plain * lisp/subr.el (start-process-shell-command): Add recommended signature to docstring. This hides the argument ARGS whose use is discouraged. This also makes the argument COMMAND visible so the user understands what the docstring is referring to. -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill --=-=-= Content-Type: text/x-patch Content-Disposition: attachment; filename=0001-Improve-docstring-of-start-process-shell-command.patch >From 912261c8dfb337c6f94ca81a495a3690c0628f1e Mon Sep 17 00:00:00 2001 From: Damien Cassou Date: Mon, 16 Apr 2018 16:06:36 +0200 Subject: [PATCH] Improve docstring of start-process-shell-command * lisp/subr.el (start-process-shell-command): Add recommended signature to docstring. This hides the argument ARGS whose use is discouraged. This also makes the argument COMMAND visible so the user understands what the docstring is referring to. --- lisp/subr.el | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/lisp/subr.el b/lisp/subr.el index 9cf7d596cd..59bac5a195 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -3107,7 +3107,9 @@ start-process-shell-command An old calling convention accepted any number of arguments after COMMAND, which were just concatenated to COMMAND. This is still supported but strongly -discouraged." +discouraged. + +\(fn NAME BUFFER COMMAND)" (declare (advertised-calling-convention (name buffer command) "23.1")) ;; We used to use `exec' to replace the shell with the command, ;; but that failed to handle (...) and semicolon, etc. -- 2.14.3 --=-=-=--