Re: [PATCH v3 2/2] docs: tracing: Reduce maxdepth in index documentation

Purva Yeshi
2025-03-18T11:35:47Z

On 14/03/25 18:11, Steven Rostedt wrote:
> On Fri, 14 Mar 2025 14:26:37 +0530
> Purva Yeshi <purvayeshi550@gmail.com> wrote:
>
>> Thanks for the reference. I will keep this in mind for future patch
>> series and include a cover letter.
>
> Note, a cover letter isn't really necessary here. Why? because these
> are pretty much two agnostic patches. One fixes the maxdepth, the other
> is changing the layout for readability.
>
> Cover letters are best when there's a bigger picture being had. That
> is, the patch series is set out to accomplish a single goal that is
> broken up into little steps. A cover letter explains what the goal is
> and why and how. Each patch after that explains what that patch is
> doing (why and how), but from the focus of that particular change.
>
> As these patches could theoretically be sent as two separate patches
> and not as a series as they don't really share the same goal, a cover
> letter's only purpose here would be to make the email thread look a
> little nicer ;-) But that's about it.
>
> -- Steve

Got it! Thanks for the clarification Steve.

Best Regards,
Purva Yeshi