On Mon, Mar 17, 2025 at 03:26:45PM -0500, Robert Dubner wrote:
> 
> 
> > -----Original Message-----
> > From: Jakub Jelinek <ja...@redhat.com>
> > Sent: Monday, March 17, 2025 16:05
> > To: Iain Sandoe <idsan...@googlemail.com>
> > Cc: Robert Dubner <rdub...@symas.com>; GCC Patches <gcc-
> > patc...@gcc.gnu.org>
> > Subject: Re: [PATCH] cobol: Eliminate CPPFLAGS assignment from Make-
> > lang.in [PR119213].
> > 
> > On Mon, Mar 17, 2025 at 07:57:43PM +0000, Iain Sandoe wrote:
> > > >         PR cobol/119213
> > > >         * Make-lang.in:   Eliminate CPPFLAGS= assignment.
> > > >         * cdf.y:          Modify #includes that reference libgcobol.
> > > >         * cobol1.cc:      Modify #includes that reference libgcobol.
> > > >         * except.cc:      Modify #includes that reference libgcobol.
> > > >         * gcobolspec.cc:  Modify #includes that reference libgcobol.
> > > >         * genapi.cc:      Modify #includes that reference libgcobol.
> > > >         * gengen.cc:      Modify #includes that reference libgcobol.
> > > >         * genmath.cc:     Modify #includes that reference libgcobol.
> > > >         * genutil.cc:     Modify #includes that reference libgcobol.
> > > >         * parse.y:        Modify #includes that reference libgcobol.
> > > >         * scan.l:         Modify #includes that reference libgcobol.
> > > >         * structs.cc:     Modify #includes that reference libgcobol.
> > > >         * symbols.cc:     Modify #includes that reference libgcobol.
> > > >         * symfind.cc:     Modify #includes that reference libgcobol.
> > > >         * util.cc:        Modify #includes that reference libgcobol.
> > 
> > Plus for ChangeLog formatting again
> > s/: *\([EM]\)/: \1/
> 
> I will, of course, make that change.  But I can't help but ask: Is there
> some reason for eliminating the spaces that cause the comments to line up?
> 
> I did it, reflexively, because I think that lining stuff like that up iss
> easier to understand and more clear than.
> 
>       PR cobol/119213
>       * Make-lang.in: Eliminate CPPFLAGS= assignment.
>       * cdf.y: Modify #includes that reference libgcobol.
>       * cobol1.cc: Modify #includes that reference libgcobol.
>       * except.cc: Modify #includes that reference libgcobol.
>       * gcobolspec.cc: Modify #includes that reference libgcobol.
>       * genapi.cc: Modify #includes that reference libgcobol.
>       * gengen.cc: Modify #includes that reference libgcobol.
>       * genmath.cc: Modify #includes that reference libgcobol.
>       * genutil.cc: Modify #includes that reference libgcobol.
>       * parse.y: Modify #includes that reference libgcobol.
>       * scan.l: Modify #includes that reference libgcobol.
>       * structs.cc: Modify #includes that reference libgcobol.
>       * symbols.cc: Modify #includes that reference libgcobol.
>       * symfind.cc: Modify #includes that reference libgcobol.
>       * util.cc: Modify #includes that reference libgcobol.
> 
> Meanwhile I am going to take all this as a "good to go", once I fix the
> comment and my libgfortran typo.

https://www.gnu.org/prep/standards/html_node/Change-Logs.html
contains some of the reasons and something about the formatting etc.
When you repeat the same description over and over, normally one just writes
        * cdf.y: Modify #includes that reference libgcobol.
        * cobol1.cc: Likewise.
        * except.cc: Likewise.
etc. (or Ditto. instead of Likewise.).
The filenames can have different length and in most cases (the above case
is kind of special since it is a global modification of the files, not a
change in a particular function) there is also often large function name,
so if you tried to align the descriptions and still had to fit on 80
columns, it really wouldn't fit or you could have there just one or two
short words.  Often the description doesn't fit on
the same line fully and needs to be wrapped, the space in there is precious
and consistency is more important than some beatiful look, especially when
different people would have different opinions on what is nice.

There is another rule, if the description contains multiple sentences,
dot is followed by 2 spaces unless it is at the end of line (but that is a
general formatting rule also e.g. in code comments).

        Jakub

Reply via email to