[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

ChangeLog styles (was: master 7e387c9: * lisp/man.el (Man-width-max): Ne

From: Juri Linkov
Subject: ChangeLog styles (was: master 7e387c9: * lisp/man.el (Man-width-max): New defcustom (bug#32536, bug#9385))
Date: Sun, 08 Dec 2019 23:45:09 +0200
User-agent: Gnus/5.13 (Gnus v5.13) Emacs/27.0.50 (x86_64-pc-linux-gnu)

> P.S. And please do not "optimize" the log messages the way you did in
> this commit: it will make the generated ChangeLog entry look wrong.
> Please only use the ChangeLog-style text in the header line of the log
> entry if it is the entire text; otherwise please come up with some
> summary there, and leave the ChangeLog-style text in its original
> form, without an empty line in between.  TIA.

This is not optimization.  The first line of this log message is
a complete sentence.  It provides all information about the change,
answering the questions: WHERE and WHAT.

WHERE: * lisp/man.el (Man-width-max)

WHAT: New defcustom

If even adds the references to bug reports: bug#32536, bug#9385

Many log messages don't provide the information about location of the
change in their subject, so it's difficult to guess what files are
affected by the change.

For example, such log subject provides no clue about the affected package:

  Fix documentation of '-position' server command

It's not clear what is a server command it's talking about.
It takes additional efforts to output the full message to see
that actually it meant the package lisp/server.el.
Such subject would be much more clear:

  * lisp/server.el: Fix documentation of '-position' command

reply via email to

[Prev in Thread] Current Thread [Next in Thread]