Re: Formatting changes to mi-main.c

[Nick Roberts <nickrob at snap dot net dot nz>]

 > 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