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

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <23f1706f-e12e-4a4a-9919-6e654df8cc31@gmail.com>
Date: Tue, 18 Mar 2025 17:05:39 +0530
From: Purva Yeshi <purvayeshi550@...il.com>
To: Steven Rostedt <rostedt@...dmis.org>
Cc: Bagas Sanjaya <bagasdotme@...il.com>,
 Masami Hiramatsu <mhiramat@...nel.org>,
 Mathieu Desnoyers <mathieu.desnoyers@...icios.com>,
 Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
 linux-trace-kernel@...r.kernel.org, linux-doc@...r.kernel.org
Subject: Re: [PATCH v3 2/2] docs: tracing: Reduce maxdepth in index
 documentation

On 14/03/25 18:11, Steven Rostedt wrote:
> On Fri, 14 Mar 2025 14:26:37 +0530
> Purva Yeshi <purvayeshi550@...il.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