Messages in this thread | | | Date | Mon, 1 May 2023 21:52:20 -0400 | From | Steven Rostedt <> | Subject | Re: [PATCH v4 00/12] sched: Avoid unnecessary migrations within SMT domains |
| |
On Mon, 1 May 2023 18:42:55 -0700 Ricardo Neri <ricardo.neri-calderon@linux.intel.com> wrote:
> I am sorry changelogs are not sufficiently clear. I thought stating the > overall goal in the cover letter was enough. In the future, would you > prefer that I repeat the cover letter instead of referring to it? Should > individual changelogs state the overall goal?
Yes. Every commit should have a change log that explains why that commit was done without having to look elsewhere.
The cover letter should be the summary of what the patches do. But 5 to 10 years from now, when a git bisect comes across a commit, there's no guarantee that a cover letter will be easily found. The change log may be the only thing a developer debugging some code will have to understand what the change was for.
I'm guilty of having poor change logs which I myself suffered from, as I don't remember what I meant. So I've been more adamant on adding more detail to my change logs which has saved me a few times.
-- Steve
| |