Short commit message was Re: [rtems commit] rtems: Fix rtems_task_mode()

[Gedare Bloom]

On Thu, Mar 18, 2021 at 8:21 AM Sebastian Huber
<sebastian.huber at embedded-brains.de> wrote:
>
> Hello Joel,
>
> On 18/03/2021 14:15, Joel Sherrill wrote:
>
> >
> > rtems: Fix rtems_task_mode()
> >
> > Do the ASR and preemption mode change only if requested by the mode
> > mask.  The bug was introduced by
> > 508f868237225a75e566d9fd304206363cfe441d.
>
> I don't know what is wrong with this commit message subject. It tells
> you the scope, that it is a bugfix, the affected function, and uses 28
> of the available 50 characters. What would be your better alternative?
>
+1

A valid complaint would be if Sebastian's commit just said "Fix modes".

The short-commit is mostly useful in the up-front reviewer queue
triage. There isn't much room to get too detailed there, on purpose.

Put as much detail as you want in the "body" of the commit message. We
have this guidance in
https://devel.rtems.org/wiki/Developer/Git#GitCommits and we should
migrate it to the
https://docs.rtems.org/branches/master/eng/vc-users.html#creating-a-patch
area.

Probably, we could use to provide a little more guidance, such as what
to use in the first "tag" part before the colon. I thought we had that
at one time, but I can't find anything about it.

-Gedare

> --
> embedded brains GmbH
> Herr Sebastian HUBER
> Dornierstr. 4
> 82178 Puchheim
> Germany
> email: sebastian.huber at embedded-brains.de
> phone: +49-89-18 94 741 - 16
> fax:   +49-89-18 94 741 - 08
>
> Registergericht: Amtsgericht München
> Registernummer: HRB 157899
> Vertretungsberechtigte Geschäftsführer: Peter Rasmussen, Thomas Dörfler
> Unsere Datenschutzerklärung finden Sie hier:
> https://embedded-brains.de/datenschutzerklaerung/
>
> _______________________________________________
> devel mailing list
> devel at rtems.org
> http://lists.rtems.org/mailman/listinfo/devel