From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (qmail 19744 invoked by alias); 4 Feb 2007 08:26:14 -0000 Received: (qmail 19734 invoked by uid 22791); 4 Feb 2007 08:26:13 -0000 X-Spam-Check-By: sourceware.org Received: from viper.snap.net.nz (HELO viper.snap.net.nz) (202.37.101.8) by sourceware.org (qpsmtpd/0.31) with ESMTP; Sun, 04 Feb 2007 08:26:08 +0000 Received: from kahikatea.snap.net.nz (84.60.255.123.dynamic.snap.net.nz [123.255.60.84]) by viper.snap.net.nz (Postfix) with ESMTP id CB0D73D81B6; Sun, 4 Feb 2007 21:26:00 +1300 (NZDT) Received: by kahikatea.snap.net.nz (Postfix, from userid 500) id 1BD1D4F728; Sun, 4 Feb 2007 21:26:01 +1300 (NZDT) From: Nick Roberts MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Transfer-Encoding: 7bit Message-ID: <17861.39064.540693.64264@kahikatea.snap.net.nz> Date: Sun, 04 Feb 2007 08:26:00 -0000 To: Eli Zaretskii Cc: gdb-patches@sources.redhat.com Subject: Re: Formatting changes to mi-main.c In-Reply-To: References: <17860.8466.150801.692398@kahikatea.snap.net.nz> X-Mailer: VM 7.19 under Emacs 22.0.93.5 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: 2007-02/txt/msg00035.txt.bz2 > However: > > > *** 40,46 **** > > #include "interps.h" > > #include "event-loop.h" > > #include "event-top.h" > > ! #include "gdbcore.h" /* for write_memory() */ > > #include "value.h" > > #include "regcache.h" > > #include "gdb.h" > > --- 40,46 ---- > > #include "interps.h" > > #include "event-loop.h" > > #include "event-top.h" > > ! #include "gdbcore.h" /* For write_memory(). */ > > Do the GNU coding standards require that even comments that are not > alone on their lines be complete sentences? I didn't think they do, > and a quick look in standards.texi didn't find such a guideline. The manual doesn't clarify the issue. It describes using capitals and full stops for sentences and then gives examples of comments that don't use them. > Personally, I like the brief comment style in the original better. > Anyway, the above isn't a complete sentence anyway, even if we begin > it with a capital letter and end it with a period. Maybe it isn't but the comments span a continuous spectrum so it would be hard to say at what point they constitute a sentence. Which brings things pretty much to my starting position: There are *many* instances of one line comments in this file without a full stop. Perhaps the practice is just to give multi-line comments a full stop (maybe one liners are regarded as phrases). > Lastly, if, while at that, you find "foo()" being used as a reference > to the function `foo', please change it to `foo'; that part _is_ in > GNU coding standards. OK. > Thanks again. -- Nick http://www.inet.net.nz/~nickrob