From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 3817 invoked by alias); 28 Mar 2011 20:23:10 -0000 Received: (qmail 3808 invoked by uid 22791); 28 Mar 2011 20:23:09 -0000 X-SWARE-Spam-Status: No, hits=-1.9 required=5.0 tests=AWL,BAYES_00,T_RP_MATCHES_RCVD X-Spam-Check-By: sourceware.org Received: from mail.codesourcery.com (HELO mail.codesourcery.com) (38.113.113.100) by sourceware.org (qpsmtpd/0.43rc1) with ESMTP; Mon, 28 Mar 2011 20:23:06 +0000 Received: (qmail 25633 invoked from network); 28 Mar 2011 20:23:05 -0000 Received: from unknown (HELO scottsdale.localnet) (pedro@127.0.0.2) by mail.codesourcery.com with ESMTPA; 28 Mar 2011 20:23:05 -0000 From: Pedro Alves To: gdb-patches@sourceware.org Subject: Re: [RFA] Refactor breakpoint_re_set_one Date: Mon, 28 Mar 2011 20:24:00 -0000 User-Agent: KMail/1.13.5 (Linux/2.6.35-28-generic; KDE/4.6.1; x86_64; ; ) Cc: Joel Brobecker , Thiago Jung Bauermann References: <1301322874.2433.0.camel@hactar> <20110328184647.GD3670@adacore.com> In-Reply-To: <20110328184647.GD3670@adacore.com> MIME-Version: 1.0 Content-Type: Text/Plain; charset="iso-8859-1" Content-Transfer-Encoding: quoted-printable Message-Id: <201103282123.00694.pedro@codesourcery.com> X-IsSubscribed: yes 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 X-SW-Source: 2011-03/txt/msg01142.txt.bz2 On Monday 28 March 2011 19:46:47, Joel Brobecker wrote: > > +/* Find the SaL locations corresponding to the given addr_string. */ >=20 > By convention `addr_string' should be capitalized.=20 > It's one of these things I really wonder why we do it, but anyways... Wonder no more. :-) =46rom , 5.2 Commenting Your Work: The comment on a function is much clearer if you use the argument names to speak about the argument values. The variable name itself should be lower = case, but write it in upper case when you are speaking about the value rather ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ than the variable itself. Thus, "the inode number NODE_NUM" rather than "a= n inode". ^^^^^^^^^^^^^^^^^^^^^^^^ Thus, this is not restricted, or really specific of function arguments. --=20 Pedro Alves