[PATCH phosphor-host-ipmid v2 1/5] Add get/set ipmid command support with correct DBUS property handling.

[Stewart Smith]

Peng Fei BG Gou <shgoupf at cn.ibm.com> writes:
> I'm sorry that for my commits I only have "1 line" comments for them.
> I will try to fix them by changing the comments that already been
> committed. But there are plenty of commits that is "1 line" comments
> as below. So would you mind telling me in what situation I am allowed
> to have "1 line" comment and in what situation I need to have a
> multiple-line comment?

Yeah, there's a lot of poor commit messages in OpenBMC so far, which
gives you the opportunity to be much better than others!

Personally, my guide is: if someone casually familiar with the project
and concepts can see that the patch is obviously correct in less than
four seconds, a one line commit message is okay.

My goal for a commit message is to give enough information to someone
casually familiar with the project and subject matter enough to go and
start to learn enough to completely understand the patch.

Even then, sometimes a bit more info is useful.
For example:
https://github.com/open-power/skiboot/commit/d4b142823e28deed097cf79b25d8d1e60b6f4e67

An example of single line commit message:
https://github.com/open-power/skiboot/commit/916196d4cc0e070369ff6aa1363fa39339f8cad1
(which is just adding release notes, so it's *obvious* what this patch
does)

Or
https://github.com/torvalds/linux/commit/5c477b45792fb8ccd279162483aa57cc8ee40ae1
which is just the wiring up of a new syscall for PARISC.