On Tue, May 20, 2025 at 05:15:33PM +0200, Alejandro Colomar wrote:
> I've based on gnulib commits, which I believe follow the same
> guidelines. For example:
>
> commit 6608062398ef4c983a58b90a1520c39f12fb7ac1
> Author: Paul Eggert <egg...@cs.ucla.edu>
> Date: Fri Jan 10 10:34:58 2025 -0800
>
> doc: document some file system portability issues
>
> * doc/glibc-functions/flistxattr.texi:
> * doc/glibc-functions/listxattr.texi:
> * doc/glibc-functions/llistxattr.texi:
> * doc/posix-functions/fchdir.texi, doc/posix-functions/fstat.texi:
> * doc/posix-functions/fstatvfs.texi:
> Document some portability gotchas that Gnulib does not work around.
>
> Now I realize that maybe my changelog misses the trailing ':' for the
> entries that have no text (because it's only once at the end)? So for
> example instead of
>
> gcc/c-family/ChangeLog:
>
> * c-common.h
> * c-common.def
> * c-common.cc (c_countof_type): Add __countof__ operator.
>
> I should do this?
>
> gcc/c-family/ChangeLog:
>
> * c-common.h:
> * c-common.def:
> * c-common.cc (c_countof_type): Add __countof__ operator.
>
> Or maybe this?
>
> gcc/c-family/ChangeLog:
>
> * c-common.h:
> * c-common.def:
> * c-common.cc (c_countof_type):
> Add __countof__ operator.
We don't use (at least mostly) any of these, instead use
* c-common.h (whatever changed): Description.
* c-common.def (whatever else changed): Likewise.
* c-common.cc (again what changed): Likewise.
and similar (or Ditto instead of Likewise).
And just c-common.h or c-common.def without actually specifying what
you've changed there is generally bad, there are some rare exceptions
(e.g. if you add #include, that is mentioned on the whole file, or
if there are massive repetitive changes everywhere).
Jakub
