From unknown Sat Aug 16 12:40:51 2025 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable MIME-Version: 1.0 X-Mailer: MIME-tools 5.509 (Entity 5.509) Content-Type: text/plain; charset=utf-8 From: bug#31191 <31191@debbugs.gnu.org> To: bug#31191 <31191@debbugs.gnu.org> Subject: Status: 26.1; [PATCH] Improve docstring of start-process-shell-command Reply-To: bug#31191 <31191@debbugs.gnu.org> Date: Sat, 16 Aug 2025 19:40:51 +0000 retitle 31191 26.1; [PATCH] Improve docstring of start-process-shell-command reassign 31191 emacs submitter 31191 Damien Cassou severity 31191 minor tag 31191 patch thanks From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 07:40:01 2018 Received: (at submit) by debbugs.gnu.org; 17 Apr 2018 11:40:01 +0000 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 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 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 X-Spam-Checker-Version: SpamAssassin 3.3.2 (2011-06-06) on eggs.gnu.org X-Spam-Level: X-Spam-Status: No, score=0.8 required=5.0 tests=BAYES_50,T_DKIM_INVALID autolearn=disabled version=3.3.2 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 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 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 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 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) 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) 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 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) 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) From: Damien Cassou To: bug-gnu-emacs@gnu.org Subject: 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> MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="=-=-=" 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-Received-From: 2001:4830:134:3::11 X-Spam-Score: -4.1 (----) X-Debbugs-Envelope-To: submit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -5.1 (-----) --=-=-= 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 --=-=-=-- From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 07:43:11 2018 Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 11:43:11 +0000 Received: from localhost ([127.0.0.1]:56774 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8P0w-0003Yt-T0 for submit@debbugs.gnu.org; Tue, 17 Apr 2018 07:43:11 -0400 Received: from mail-it0-f46.google.com ([209.85.214.46]:39049) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8P0v-0003Yh-Nl for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 07:43:09 -0400 Received: by mail-it0-f46.google.com with SMTP id 85-v6so13120003iti.4 for <31191@debbugs.gnu.org>; Tue, 17 Apr 2018 04:43:09 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=IZXP4erbPZ98JFZb0QYyyYl7pKF9j7auG4cJlW5sk3Y=; b=YBUfUYYleYU57oACFS9evPABLWvJ4huZxIlMWTW6bt8yPl75ONyrY5+YMV0kV6CBo/ SUzXYNC4vccneU3mMQOAPOzpKFEVsFzHpaxNYKv1ZYbJhEEMqz6Xdv+CQ4QHHtede6NE rwRRo5G2HQbMSl0bZf+KRhCpJuiF++cRKPjSOd/02MB6U/KJRqy0ya46Glh5MC6OPDYG 2Enn9pRY3+XIJ8Qns+hpzJk9Rokkb08nknEqvUH/ep2q2VxkiIy454Up9+L/DueABnOX PbaajIxk0IIW8+U41RVD0uZqeokDmvQEehl9EkR+x5SHXqr5d3qyAi6SF47cOqMiIQrx E7bA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=IZXP4erbPZ98JFZb0QYyyYl7pKF9j7auG4cJlW5sk3Y=; b=d0+sJ44bfzL2XVpNG6kPY/59IvfBu5pN6m6WD5hbsXsidnoJNnLPyrftrMijRZoACb B4oQSjSUwlFvjQueVOafAYqcPQUfhHw4EfxHptxVTqJZG6lMSvfkoBa2r2TzqJF2pHmz 4b3S0uzbyCJS8DKlZNUa0rmJ2/+oCPkemIZcSBHdnvS11aJgYhEtBq+3rU/tEMlHIbAm 6+e/sjVlLJZ84YCSfRicY4IKaDSYnqlywz2iDjbR72NjSb5kN54Akz/4hwNzoDBjP76V bPGyN8CpvFtYK11ZUJBFkFnrMO8M/nknThk48ZVZDaztB6e5ALFxBN6DE53NiE0VJVrr FQfQ== X-Gm-Message-State: ALQs6tC98ZEmybF30hHsBkCBjLGx/OMqCKxmHC+hQD7Cpz4Nay2pLfx/ McZNfV72oJYv9AK7Cli5Pewzcg== X-Google-Smtp-Source: AIpwx48R5FR17AEFL5/U0MiHkkjcS05qXihbw8jqYb4JXGgXubUn/cpvo32ViDXvJa9lNXhJIK/vuw== X-Received: by 2002:a24:5886:: with SMTP id f128-v6mr805239itb.33.1523965383990; Tue, 17 Apr 2018 04:43:03 -0700 (PDT) Received: from zebian (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34]) by smtp.googlemail.com with ESMTPSA id f125-v6sm516535ita.22.2018.04.17.04.43.02 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 17 Apr 2018 04:43:03 -0700 (PDT) From: Noam Postavsky To: Damien Cassou Subject: Re: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command References: <87o9iijc3u.fsf@cassou.me> Date: Tue, 17 Apr 2018 07:43:02 -0400 In-Reply-To: <87o9iijc3u.fsf@cassou.me> (Damien Cassou's message of "Tue, 17 Apr 2018 13:39:33 +0200") Message-ID: <87y3hmt5x5.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 31191 Cc: 31191@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Damien Cassou writes: > * 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. > +\(fn NAME BUFFER COMMAND)" > (declare (advertised-calling-convention (name buffer command) "23.1")) I think this is redundant since advertised-calling-convention already does the same. From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 08:44:25 2018 Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 12:44:25 +0000 Received: from localhost ([127.0.0.1]:56829 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8PyB-0006zn-ON for submit@debbugs.gnu.org; Tue, 17 Apr 2018 08:44:25 -0400 Received: from mail.choca.pics ([62.210.108.126]:53020) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8Py9-0006zY-HX for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 08:44:22 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 59EE723240ED; Tue, 17 Apr 2018 14:44:20 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id L1RprWW8xEsr; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 45B4A23240F6; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics 45B4A23240F6 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1523969059; bh=HnLdK8VTQ+J3pDWPg6xfSnQ35nFVlZezKjJwimiFskQ=; h=From:To:Date:Message-ID:MIME-Version; b=bvrzZYEmkVFwZfJp0L+Pb11FOpRqWkCvKVkYo6biUxHsIyVExWAO9ZQx/ttFCnHgl qWxTOYM/ACv/kSGzvTrVVW194JKaLiz2VAAZ3/7kK2XwMAYDB8ioLvJCfhQz9rMbkJ ietZgHWvQU8Sg51kt6VkRXP4qjSoxmOX8u3BYlwKKs6o71MbF7l2Fpj+51S97rT8uj 8N0ZtTCAgDreN3D7SXz191livNhhewKP4kzoAhlEmZMDbD0zTLUyucvr0yp74SygmL J3+j2lfRG+8zMnQgZUQm+/2IIks9ot5aDTH1CQxNd8Phm8E8eEHCmHTJXZvfJFcxDc zxiIqIw56g/9w== X-Virus-Scanned: amavisd-new at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id 1-io1loBDiPh; Tue, 17 Apr 2018 14:44:19 +0200 (CEST) Received: from luz4 (unknown [IPv6:2a00:5884:8368:0:981a:1b8d:5415:a323]) by mail.choca.pics (Postfix) with ESMTPSA id E771723240ED; Tue, 17 Apr 2018 14:44:18 +0200 (CEST) From: Damien Cassou To: Noam Postavsky Subject: Re: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command In-Reply-To: <87y3hmt5x5.fsf@gmail.com> References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> Date: Tue, 17 Apr 2018 14:44:17 +0200 Message-ID: <87k1t6j93y.fsf@cassou.me> MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 31191 Cc: 31191@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Noam Postavsky writes: >> +\(fn NAME BUFFER COMMAND)" >> (declare (advertised-calling-convention (name buffer command) "23.1")) > > I think this is redundant since advertised-calling-convention already > does the same. you are right, thank you. I didn't know about that and helpful does not take it into account (I've just reported the issue). What is the preferred way to advertise a signature, the declare form or a last line in the docstring? If you answer the question, I can fix the manual to add links between (info "(elisp) Declare Form") and (info "(elisp) Function Documentation"). -- Damien Cassou http://damiencassou.seasidehosting.st "Success is the ability to go from one failure to another without losing enthusiasm." --Winston Churchill From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 09:06:34 2018 Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 13:06:35 +0000 Received: from localhost ([127.0.0.1]:56865 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QJe-0007YC-NJ for submit@debbugs.gnu.org; Tue, 17 Apr 2018 09:06:34 -0400 Received: from mail-io0-f172.google.com ([209.85.223.172]:42556) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QJd-0007Xv-26 for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 09:06:33 -0400 Received: by mail-io0-f172.google.com with SMTP id d5so22249131iob.9 for <31191@debbugs.gnu.org>; Tue, 17 Apr 2018 06:06:33 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=4W81yFK5FIOezWyyUcxxw6v61q9gWVuyEqpb8S7l+SU=; b=UNmMWsoh2akAV5tB+fcSYy5c9rgh4PYXOJPbebKMQQW2kOSTvr/CZTVWevoh5wPNpI bd/Ckb9LSWGb/yEcQjTp5GGUgs9D48mQMnYJaEdvlXXKOnk6gSDgCxZ3apXLhh9GNE8x laMQkqjGyxV75tm0hr79i0moxbhZUNZ9aBSRrftFAy//IKKRU0eo5YZZOVVdCIfWWzuo Y0kG5znGVzmzvy7saVA4H5WVMtMI+ZGjOT2N5vsfBJ+SQh0kt6J9yyWcpcS3X5T4izLY He6WXxF2X12V3GkES1kHMFOBDLgD93gkJlevXkXROOw+Q0FdVCAbEZxqq144dbC6RRGm eeYQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=4W81yFK5FIOezWyyUcxxw6v61q9gWVuyEqpb8S7l+SU=; b=dJa1ajKzy4ltnfpvHRdHgo1MqbmNXp0TxfwPozjqEZsaM3Fg+hpPgIN/4d8AJICSpT lssONb/QrXF0vQOpSr9ACPjRVcuOQM6bp1s3vwBfRSGOwNcjkLMBbgQv44bPgr7nhPRF oaEllkZi+bPCC+95saih/ZqxwvX4Mc+Kso77+DYZRKHYOMt+oKLsxV8/dM4nLQlHMtyd JrBR6Ugd4+BICm8KLhWofMn9i2NEDZ5IzphU76VI9yhvU5p+M7MBw7NpSgtKaFWR7fkr VntfXTT+R4/feHZRoJS/2bdVOSeUQIBPJPHwmUMmooVoqoaCzp0Z07VD0V4R/AO/evmT XzWg== X-Gm-Message-State: ALQs6tDDMiJI7DrlWwqB578Ts4Vef7UfPbHf26pwkaWmC4Pk3DeanzsZ O/qqJEZEY70ODqCKBxvUUZbXxQ== X-Google-Smtp-Source: AIpwx4+4e4VReeyly+1OWFMDaGovM8zP8bjuPhxkpOiSgMci7F0bA4UboLEvjV9FvbTsX56/a1tsoQ== X-Received: by 10.107.101.7 with SMTP id z7mr1776224iob.198.1523970384945; Tue, 17 Apr 2018 06:06:24 -0700 (PDT) Received: from zebian (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34]) by smtp.googlemail.com with ESMTPSA id x5sm7187403iod.5.2018.04.17.06.06.24 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 17 Apr 2018 06:06:24 -0700 (PDT) From: Noam Postavsky To: Damien Cassou Subject: Re: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> <87k1t6j93y.fsf@cassou.me> Date: Tue, 17 Apr 2018 09:06:23 -0400 In-Reply-To: <87k1t6j93y.fsf@cassou.me> (Damien Cassou's message of "Tue, 17 Apr 2018 14:44:17 +0200") Message-ID: <87vacqt228.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 31191 Cc: 31191@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) Damien Cassou writes: > Noam Postavsky writes: >>> +\(fn NAME BUFFER COMMAND)" >>> (declare (advertised-calling-convention (name buffer command) "23.1")) >> >> I think this is redundant since advertised-calling-convention already >> does the same. > > you are right, thank you. I didn't know about that and helpful does not > take it into account (I've just reported the issue). > > What is the preferred way to advertise a signature, the declare form or > a last line in the docstring? If you answer the question, I can fix the > manual to add links between (info "(elisp) Declare Form") and (info > "(elisp) Function Documentation"). The advertised-calling-convention declaration should be used when you want the old way of calling to trigger a warning during byte compilation. Otherwise, the docstring method should be used. From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 09:45:25 2018 Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 13:45:25 +0000 Received: from localhost ([127.0.0.1]:56901 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QvF-0008Sk-Fd for submit@debbugs.gnu.org; Tue, 17 Apr 2018 09:45:25 -0400 Received: from mail.choca.pics ([62.210.108.126]:54030) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8QvB-0008SZ-6J for 31191@debbugs.gnu.org; Tue, 17 Apr 2018 09:45:22 -0400 Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 264062324158; Tue, 17 Apr 2018 15:45:20 +0200 (CEST) Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10032) with ESMTP id 34xSRIKtczxR; Tue, 17 Apr 2018 15:45:19 +0200 (CEST) Received: from localhost (localhost.localdomain [IPv6:::1]) by mail.choca.pics (Postfix) with ESMTP id 2DEF52324177; Tue, 17 Apr 2018 15:45:19 +0200 (CEST) DKIM-Filter: OpenDKIM Filter v2.10.3 mail.choca.pics 2DEF52324177 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=cassou.me; s=9EA44F5C-DEF4-11E6-A83F-A08DF322D8FB; t=1523972719; bh=7bLP5mrL9Cp7OotE7cR8QE25ercKPqLQWx/9wtdVqAI=; h=Date:MIME-Version:To:From:Message-ID; b=Y5e4Blh96HgsVBj0yoNej1s6NqG6TIzSJGdJLX4XcJvAoIybJMXF9kHIbEylUQM0F LedWTxdI2JVknMAcfo4K2TGz9XLwQVxmn+ouMNGAQ9fQnaYbWRXuHzCKtwIQ6DVPYe 4kW83Bh9iJtlfu8rgDvftzD0qFqOHcCZ6llcHFnGpLqwX+n33yc998a6gDmsJH26tH BsjL1EElm3d/pxHqSUpx1M8BC/kEBD7AALkxUnLrXqD5TeTo4RGj+JNDZbWZsxIsoG ozZjOc1wok88zBudzZSsXyhNiXJlhrcPwKKdFU5JlyiKxGt2Qr0WTsMYJPLAsxJPmw jLlOjepHJsvEA== X-Virus-Scanned: amavisd-new at choca.pics Received: from mail.choca.pics ([IPv6:::1]) by localhost (mail.choca.pics [IPv6:::1]) (amavisd-new, port 10026) with ESMTP id 00tXpQfxHEj7; Tue, 17 Apr 2018 15:45:19 +0200 (CEST) Received: from [IPv6:2a00:5884:8368:0:9804:7ff4:10cf:b6a6] (unknown [IPv6:2a00:5884:8368:0:9804:7ff4:10cf:b6a6]) by mail.choca.pics (Postfix) with ESMTPSA id DB4E62324158; Tue, 17 Apr 2018 15:45:18 +0200 (CEST) Date: Tue, 17 Apr 2018 15:45:16 +0200 User-Agent: K-9 Mail for Android In-Reply-To: <87vacqt228.fsf@gmail.com> References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> <87k1t6j93y.fsf@cassou.me> <87vacqt228.fsf@gmail.com> MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Autocrypt: addr=damien@cassou.me; keydata=mQINBFUw+XcBEAC5OMKAJfNcSQVK8JsiKV CbxEHLKuzqZPnAEaXGiqzYR7C2Yoc9ReCe2YGjTUF8iKCCD/hffS4h/IWRvmKO75GACURa5+GDIr Jb7IpgCB97KicResIfYrbL0KmU2cTJZ5oN9yaHkVMI+sVrSJ5q8m36WEStS9ATneGXa7MqhzVoiy ETQzG1uPvSZ0qoWuh1lLmrQ73OPu1lqsY1FUuVEVHPB95Ic3TsWwfr8Mx+bW1qweEjWzZYJpnwl7 CWUU44M9oxOgtKd2pnKMER1+kUVwLfb+6FUwg08CWNcSswkrd6gsIE6joE6n8dyV2BW9NyStYIOS nPbG/IwyoKb/C2PF0CHm+nMZ9+f3N7FTgQ1iw07t55RW8tZwD8GveTerlYYxsu4FUx9GUWAjZcK5 uMRGSoDHPmF8qSkq2ZQDGlcCqhBc5n4yeST0z5zUM6cnkBijNhQ0duq8kAwt2WNkwYJ+DHoXN6eZ mTKf+9UO7Zh37kus1M2tnuZYgqdcXsjVKPX40n5cjlTGRP/yY1vGYlH2auNghlclxSiUFZROtWdD +GeFU76S7Y+6+vtFzg4dldZtMnqFHPpP0tLtr15nj+JkKUUYec8/XuSjuwSML0cef1pdtMXZqBtR hlWgcfvnOIqoEm+tVWrUKYJ6zzg6/uSa0tokghzrEcRE3b4zpQU7dPGwARAQABtCBEYW1pZW4gQ2 Fzc291IDxkYW1pZW5AY2Fzc291Lm1lPokCQgQTAQgALAIbAwUJEs6GKQcLCQgHAwIBBhUIAgkKCw QWAgMBAh4BAheABQJX0X2LAhkBAAoJEKcSOBX13OkUTL8QAIeQy7qEC5IQvPwKYMN6wX/8X714Na dtBZRYu5yjeJXQMYKJzo/B6LEOqmCpieBGCk2DASAY7Wd9XRcrADQy4Bn7XNOEOxdvd289BU6RSr 8GG1Pcg+8cPiKzhR74+OMuxBReUWaF+V864NE1Iv2yC+6Tl4eoEkAt606LAOOku6woXDHrWr3Xq2 AYeKbauTn0KoASdHslZLGy5X2Ll/wewAs2FQ5JvehabPh91NeQwZJHoJ1gdqJ2zlGnS7hj9Kllzt tPz/17hfxGUruu4NIQAcskcMcXCbjCVxbAc3bNg3NgRkTnzPiSkLlv1Zduhpc3AHLHFz1Cfr4TM8 Ng3KXE9g+RGvb7CJCOKlbpIKzsfmmyqJxrrAX7J3yjtbzT7FdbvYiRmj4ft+NIRJH/AQktdtPgmv uSCbOlChE6XvuT7dKYYZol8HeBwh2JKEClocCe0QLu45mLGdi6k7Uz7Hx+y7a4S+86AUiDdR1x5a bWFkXa5fwzaPlrJOeZLd3smNWqODhws8gbGZoCdhICh+sVoosZnqDkZuskcbOi6bOQSh9AcYFMMH bzT4US3NQPo4WvJ1AgpvaXruLW5NlZJfjcErr4/pzoC6b/rCTSJKm7nhHZAmaEl1kIKXljpzXfXx 88Ewrh3lLCZESNIco9KcF6mzT/ElT6n1Jb95KPnPKp31u2uQINBFUw+XcBEADVNsLoOPLO+9CvH2 ysecbYtgnej3RSvGXrA+V7tnvxN3UKKxt2x/UfjZ6vFHBLs4DaVSc6nBnlQcFcSJwNv33srcDjKu o4I2p1+mkF2Cl62PcyUz8GXw95rNs3VX+LdFLFnhVyfdy0tEA37RC3laZGOCjCjhWZVzMKb5RNkU mLliAiNDm45kBooNDlBN4uMa1OehCyySdy9L6mKZUHU73kD4tPd6imwu9szW2m4wodgMEnoKRBRd Q576d5nyZXnp4vHPWw6Hk5NqOrUkRVV0mNmXtCZCdv5OxPmJ8vqj6j8HzkI+T/FGzuqp/JFDnwFU Qb0EWft16MvrywfNqCPjn/ML1kw/KMgageTLHXdO3xMLVB+5hcO9YME1VeJfEY9/vDI5aVtZ/74S nRgThE+Y1RyE+1x/nrbhdeviTffMmC74PNuVgaKett3i/1KpMGJBWJFg6FpbUdGbJzi0jySEnLCp Pk0McpRnhzSetaYbvdKdnEQpI7kuCOQ48Q7NGtRIx8Srmy5Bhf8gFfML0J84xThGzwcVqp42aijz FOMKaIvTUk0xmlgSvJF5F3V6nhBeFFwXAnUqCd9WTzz3zM/Anhln/7M4HepBRLEJg/MrfFDaxbcH 4264mIJ39DB7DxDBmTg89YcwIT8gqq2scwY8CfIGjjNvQ7FmDio7APg/QsOwARAQABiQIlBBgBCA APBQJVMPl3AhsMBQkSzoYpAAoJEKcSOBX13OkU5CEQAINqGseq7wVjy+VUqnoqSiVB7XzcoiGwe/ nBCsRV1sirodZPwA1Dxb32BhO++WI7tl7axnXZvE2HoJj9zgcqHd2jTfT5Q27cIb2klxqF9CGm8U ZTI8pqmaft4jArjZ5InyK3Dfy7CoS2auv51RE6Zy2MjBX7eD4t0lZ9mKskZgmN42OItaQXRdDWdw bjtUFk54yEzNDkPEJ4sCWZQgufpscw6+e/TWWCjhUZB21mUuSS8EG4Frn2prFNu9eAEjq3Dx6HSK Ge9k6vhd93xmeqmedcNpQveWrXS/B7RPwtXbIh4Eeuhyj8vScwkOLzGxlHUj4a5C3cY3g6cb7hMY PHVZgyS0P0wpVCXPp+irn9LY8dr0pbfORN5XNwwfT1dC/BDFnzLXs1rYdy5NArvIiZPWL4miKJ0p OFElggV8RuMxSeW2vmst4jZSzDh+DNKW78O1/9apVJgUjEZEdHJSa3hI7Gslj50ZPm7k9AXZzAFu WH3b3B9Apf/scbdFEpgYfCBcEmPptTSzIMqE7lGnj7EMRxBMN4DEG7/dzOa4MCifSPJFkaCf+yLq neLz0Nn+sSU1OEgzQgXWeQ+4TLEdZOHxwiZVcETI/jaGPqMZSyr5HvE1h9qbOWLfd1MbMVDhxuM0 ScIb9Z1POa+5aGKuMGsPTjZ1NAuPUqT8gkFby2AZKC Subject: Re: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command To: Noam Postavsky From: Damien Cassou Message-ID: <2F3633D2-03BA-4740-8A2A-0E9EC637A59B@cassou.me> X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 31191 Cc: 31191@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) On April 17, 2018 3:06:23 PM GMT+02:00, Noam Postavsky wrote: >Damien Cassou writes: >> What is the preferred way to advertise a signature, the declare form >or >> a last line in the docstring? If you answer the question, I can fix >the >> manual to add links between (info "(elisp) Declare Form") and (info >> "(elisp) Function Documentation")=2E > >The advertised-calling-convention declaration should be used when you >want the old way of calling to trigger a warning during byte >compilation=2E Otherwise, the docstring method should be used=2E Thank you=2E Can you please close this issue? I will send a patch within a= nother report=2E --=20 Damien Cassou http://damiencassou=2Eseasidehosting=2Est "Success is the ability to go from one failure to another without losing enthusiasm=2E" --Winston Churchill From debbugs-submit-bounces@debbugs.gnu.org Tue Apr 17 18:45:01 2018 Received: (at 31191) by debbugs.gnu.org; 17 Apr 2018 22:45:01 +0000 Received: from localhost ([127.0.0.1]:58169 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8ZLR-0007at-2u for submit@debbugs.gnu.org; Tue, 17 Apr 2018 18:45:01 -0400 Received: from mail-it0-f45.google.com ([209.85.214.45]:34826) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1f8ZLP-0007aa-E1; Tue, 17 Apr 2018 18:44:59 -0400 Received: by mail-it0-f45.google.com with SMTP id q85-v6so158642itc.0; Tue, 17 Apr 2018 15:44:59 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:references:date:in-reply-to:message-id :user-agent:mime-version; bh=2lDSybQGPITP3DqXtuFAE5Kw1t7Za2zBxhyQwIWkmnY=; b=MEj9yopvQ4rvZUEEIiA0AcvxVO3afnLH9lAnlDqIBaYDDeDFluPPlmnmr8wR/5fNUt anAANOUYFTiyLlRLa98KMr0FQJb9/lrdq1xFR8/IWn/wSAqdfa2mWOlfAm86TEFSx62W IrwlN6vTukG+Gt6MlKPfmtGej8J+8rQM9AWgkwtSgelQ2nYhKxgXJRkToRoEteUcxLnQ HLRVVP00pdgWm/L8f6Lw9V0TNEGjBiikwKnzkokofOSbqdRuGMrFtRA7v0M3Yruxeptt JjUwqp9xdFY973X/IcqsjJL0Q4d5S2NRw+11osmrYPiXgsboVo17rzUf7pqwZZdDwlhR j8yg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:references:date:in-reply-to :message-id:user-agent:mime-version; bh=2lDSybQGPITP3DqXtuFAE5Kw1t7Za2zBxhyQwIWkmnY=; b=tL4IzJHPeMD2hdbqqeIc/MchshTvHJ7Imv24K8vXBCKVgB4l2iiv1pw6uDlemt48kE fQ2fKq8Btg/7AHAhtUZB8RsZ0s5tSCwBdg1SNC0ks2z28P4kTPCMFwJueM7CU54PxG9+ SOoZSC0DhHVvpJPkbiwdu7LX6w4y4jbTHz6YgSX4Sv8jLoOvtnXWeADO+41gGzfBKIJU s1BBO20IplMuypqVNi1y2Viv+jAjCzT/idOPraBB+IW3plPmXtAAAnkki9hqNZMbDrvv QQ9XJp+CcNPeqSkWpQjBwZSRdR6eb/xccpWSzahbprQbETz9bIZLxQ0XMemqExwTy5BP 8Uhg== X-Gm-Message-State: ALQs6tAebP7jyRp86lB9Q7+y3aGllsai/R8LZRc9Xya44a1ymcmlfFyb BqCKJOaqkHsluJuT9C0DuIxv2Q== X-Google-Smtp-Source: AIpwx49agrBdD0S1z6ZaC9kYnRgKRGvhxZcE0teI8RtRuONxy0JJBhLexb5Vbx6YFllvTx6KRtVfkg== X-Received: by 2002:a24:4505:: with SMTP id y5-v6mr75631ita.5.1524005093687; Tue, 17 Apr 2018 15:44:53 -0700 (PDT) Received: from zebian (cbl-45-2-119-34.yyz.frontiernetworks.ca. [45.2.119.34]) by smtp.googlemail.com with ESMTPSA id p197-v6sm8251968itp.4.2018.04.17.15.44.51 (version=TLS1_2 cipher=ECDHE-RSA-CHACHA20-POLY1305 bits=256/256); Tue, 17 Apr 2018 15:44:52 -0700 (PDT) From: Noam Postavsky To: Damien Cassou Subject: Re: bug#31191: 26.1; [PATCH] Improve docstring of start-process-shell-command References: <87o9iijc3u.fsf@cassou.me> <87y3hmt5x5.fsf@gmail.com> <87k1t6j93y.fsf@cassou.me> <87vacqt228.fsf@gmail.com> <2F3633D2-03BA-4740-8A2A-0E9EC637A59B@cassou.me> Date: Tue, 17 Apr 2018 18:44:51 -0400 In-Reply-To: <2F3633D2-03BA-4740-8A2A-0E9EC637A59B@cassou.me> (Damien Cassou's message of "Tue, 17 Apr 2018 15:45:16 +0200") Message-ID: <87po2xtpuk.fsf@gmail.com> User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/26.1 (gnu/linux) MIME-Version: 1.0 Content-Type: text/plain X-Spam-Score: 0.0 (/) X-Debbugs-Envelope-To: 31191 Cc: 31191@debbugs.gnu.org X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: debbugs-submit-bounces@debbugs.gnu.org Sender: "Debbugs-submit" X-Spam-Score: -1.0 (-) forwarded 31191 https://github.com/Wilfred/helpful/issues/104 close 31191 quit Damien Cassou writes: > Thank you. Can you please close this issue? I will send a patch within another report. Sure thing. From unknown Sat Aug 16 12:40:51 2025 Received: (at fakecontrol) by fakecontrolmessage; To: internal_control@debbugs.gnu.org From: Debbugs Internal Request Subject: Internal Control Message-Id: bug archived. Date: Wed, 16 May 2018 11:24:10 +0000 User-Agent: Fakemail v42.6.9 # This is a fake control message. # # The action: # bug archived. thanks # This fakemail brought to you by your local debbugs # administrator