Re: What is our ChangeLog management policy?

[Alejandro Colomar (man-pages)]

Hi,

On 9/6/21 11:45 PM, Keith Marshall wrote:
> > I think having full details in one place is important, and guessing
> > from what Keith, Branden, and myself said, it might be possible to
> > reach consensus that git commit messages are a good place for that.
>
> I can agree to that.  In fact, my own work-flow starts with a patch
> series, managed by Mercurial Queues; for each patch, I compile a
> complete ChangeLog entry within the patch header, which means that, by
> default, it will become the commit message when the patch is finalized
> for commit -- it requires extra effort to duplicate it into a separate
> ChangeLog file, where it becomes redundant anyway.

If it helps, in the man-pages, we exclusively use the git commit message 
directly.  There we put everything.  Then at each release, Michael 
curates the commit messages into the "Changes" file in one of the last 
commits before releasing (usually with the message "Changes: Ready for 
5.13" (or whatever version)).  This is done mainly by his scripts, I 
guess.  And then the email when we release contains a copy of those 
Changes, I think (so a two level system: git with full detail; and the 
Changes with less details)  (actually, there's a shorter email for LKML 
and Glibc, with an even shorter changelog; only with things that may 
interest those lists).

* 091fbf1fe - Fri, 27 Aug 2021 02:50:30 +0200 (11 days ago) (tag: 
man-pages-5.13)
|           Ready for 5.13 - Michael Kerrisk
* 6e00b7a85 - Fri, 27 Aug 2021 02:44:07 +0200 (11 days ago)
|           iconv.1, ldd.1, accept.2, access.2, add_key.2, arch_prctl.2, 
bpf.2, chmod.2, chown.2, close_range.2, copy_file_range.2, execve.2, 
execveat.2, fanotify_mark.2, futex.2, futimesat.2, getpriority.2, 
intro.2, ioctl_tty.2, keyctl.2, link.2, membarrier.2, mkdir.2, mknod.2, 
mlock.2, mount.2, mount_setattr.2, open.2, open_by_handle_at.2, 
perf_event_open.2, pidfd_open.2, readlink.2, readv.2, rename.2, 
request_key.2, seccomp.2, sigaction.2, stat.2, statx.2, symlink.2, 
syscalls.2, umount.2, unlink.2, utimensat.2, wait.2, bsearch.3, 
fflush.3, getaddrinfo.3, getauxval.3, getopt.3, getsubopt.3, mkfifo.3, 
pthread_mutex_consistent.3, pthread_setname_np.3, pthread_tryjoin_np.3, 
scandir.3, sem_wait.3, stailq.3, strlen.3, strstr.3, termios.3, 
tsearch.3, wcslen.3, wcstok.3, wordexp.3, proc.5, capabilities.7, 
cgroups.7, fanotify.7, mount_namespaces.7, namespaces.7, 
path_resolution.7, pipe.7, posixoptions.7, user_namespaces.7, vdso.7, 
iconvconfig.8, ld.so.8: tstamp - Michael Kerrisk
* a7846609d - Fri, 27 Aug 2021 02:11:10 +0200 (11 days ago)
|           Changes: Ready for 5.13 - Michael Kerrisk
* fb7456394 - Wed, 25 Aug 2021 17:51:56 +0200 (12 days ago)
|           getaddrinfo.3: Note that 'errno' is set in parallel with 
EAI_SYSTEM - Alejandro Colomar


Cheers,

Alex


--
Alejandro Colomar
Linux man-pages comaintainer; https://www.kernel.org/doc/man-pages/
http://www.alejandro-colomar.es/