Hi Boris, On 10/9/2023 12:23 PM, Borislav Petkov wrote: > On Mon, Oct 09, 2023 at 10:59:27AM -0700, Reinette Chatre wrote: >> Is it the fourth paragraph (mentioning cdp_disable_all()) that is annoying? I >> can see that it is redundant. Would it be more palatable if the fourth paragraph >> is just dropped? > > Yes, basically you don't want to explain what a patch does as that > should be obvious from the diff. Rather, it should talk about why > a change is being done. Sure, sometimes, you need to talk about the > change in case you want to highlight certain aspects of why the code is > being changed in the first place but explaining in text what is already > visible in the diff is not very useful. > > I always give the example about git archeology here: put enough info in > the commit message so that any future reader of it can understand why > the change was done. The "what" of a patch doesn't belong to that text. > > I hope that makes more sense. > This is clear. Thank you very much. (I am still working on getting it right in practice though.) Reinette
