From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 967 invoked by alias); 22 May 2014 17:30:47 -0000 Mailing-List: contact gdb-patches-help@sourceware.org; run by ezmlm Precedence: bulk List-Id: List-Subscribe: List-Archive: List-Post: List-Help: , Sender: gdb-patches-owner@sourceware.org Received: (qmail 956 invoked by uid 89); 22 May 2014 17:30:47 -0000 Authentication-Results: sourceware.org; auth=none X-Virus-Found: No X-Spam-SWARE-Status: No, score=-1.6 required=5.0 tests=AWL,BAYES_00 autolearn=ham version=3.3.2 X-HELO: rock.gnat.com Received: from rock.gnat.com (HELO rock.gnat.com) (205.232.38.15) by sourceware.org (qpsmtpd/0.93/v0.84-503-g423c35a) with (AES256-SHA encrypted) ESMTPS; Thu, 22 May 2014 17:30:46 +0000 Received: from localhost (localhost.localdomain [127.0.0.1]) by filtered-rock.gnat.com (Postfix) with ESMTP id 7F0A91161CC; Thu, 22 May 2014 13:30:44 -0400 (EDT) Received: from rock.gnat.com ([127.0.0.1]) by localhost (rock.gnat.com [127.0.0.1]) (amavisd-new, port 10024) with LMTP id atHT-hzAkQK7; Thu, 22 May 2014 13:30:44 -0400 (EDT) Received: from joel.gnat.com (localhost.localdomain [127.0.0.1]) by rock.gnat.com (Postfix) with ESMTP id 4E1CC1161AF; Thu, 22 May 2014 13:30:44 -0400 (EDT) Received: by joel.gnat.com (Postfix, from userid 1000) id 90A0140025; Thu, 22 May 2014 10:30:44 -0700 (PDT) Date: Thu, 22 May 2014 17:30:00 -0000 From: Joel Brobecker To: Simon Marchi Cc: gdb-patches@sourceware.org Subject: Re: [PATCH] Add comment for mi_run_cmd_full Message-ID: <20140522173044.GT22822@adacore.com> References: <1400708905-14184-1-git-send-email-simon.marchi@ericsson.com> <20140521222611.GQ22822@adacore.com> <537E325D.4050908@ericsson.com> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <537E325D.4050908@ericsson.com> User-Agent: Mutt/1.5.21 (2010-09-15) X-SW-Source: 2014-05/txt/msg00561.txt.bz2 > > If I may suggest a different approach (anyone is welcome to comment > > on that too), it'd be useful to succintly say what the function does > > first, before getting into the details of the parameters. Also, I would > > group the semantics of each value of use_mi_command together. So, > > one example: > > > > # Send the command to run the test program. > > # > > # If USE_MI_COMMAND is true, the "-exec-run" command is used. > > # Otherwise, the "run" (CLI) command is used. > > # > > # ARGS is passed as argument to the command used to run the test program. > > # Beware that arguments to "-exec-run" do not have the same semantics as > > # arguments to the "run" command, so USE_MI_COMMAND influences the meaning > > # of ARGS. If USE_MI_COMMAND is true, they are arguments to -exec-run. > > # If USE_MI_COMMAND is false, they are effectively arguments passed > > # to the test program. > > > > I hope it helps! > > I think this is very clear. Should I post an updated patch ? Sure! :). Watchout for the missing second space after a period in the second to last line. -- Joel