On Mon, 9 May 2022 at 06:30, Markus Armbruster <arm...@redhat.com> wrote: > Always, always, *always* document your reasons for doing stuff right in > the commit message, unless they are blindingly obvious. I understand > reasons can be obvious enough to the author. Document them anyway if > there is any chance they are not obvious to others.
It's also nice for code-generators to say who they are in this kind of "this file is autogenerated" comment. For instance our own decodetree script's comments read /* This file is autogenerated by scripts/decodetree.py. */ -- PMM
