Re: [PATCH RESEND] Documentation: kprobetrace: Improve readability

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Sat, 24 Sep 2022 15:32:29 +0200
Yoann Congal <yoann.congal@xxxxxxxx> wrote:

> 
> On 9/21/22 22:20, Jonathan Corbet wrote:
> > - This patch almost certainly should be split up.  At a minimum, I 
> > would put the pure markup changes in one, and more substantive 
> > changes in the other.  While you're at it, please consider whether 
> > the document *really* needs all that ``literal text`` or not.
> 
> 
> On 9/22/22 04:47, Steven Rostedt wrote:>>> Yoann Congal 
> <yoann.congal@xxxxxxxx> writes:
> >>>> Improve readability of kprobetrace documentation by adding 
> >>>> markup (mainly code snippets), fixing some typos and splitting 
> >>>> some paragraphs.
> >>>> 
> >>>> Signed-off-by: Yoann Congal <yoann.congal@xxxxxxxx> --- 
> >>>> Documentation/trace/kprobetrace.rst | 128 
> >>>> ++++++++++++++-------------- 1 file changed, 66 insertions(+), 
> >>>> 62 deletions(-)
> > No. This file belongs to the tracing maintainers (I'll need to update
> > the MAINTAINERS file, thanks Jon for letting me know).
> > And yes, there's too much markup added to it.
> > 
> > NACK on that.
> > 
> > But there are some other clean ups in that patch that I have no 
> > problem with.
> 
> Hi,
> 
> I'll send a v2 splitted and a lot less markup added (CC'ing the tracing 
> maintainers). I guess I got a bit carried away once I started...
> 
> Steven, without adding any markup where there was not previously, how do 
> you feel about changing the '...'/"..." by ``...`` where applicable?

Hi, I'm the original author of that document.
I think it depends on the context (unless mechanically replaced.)
I will review it, so plaese split that part.

Thank you,

-- 
Masami Hiramatsu (Google) <mhiramat@xxxxxxxxxx>



[Index of Archives]     [Kernel Newbies]     [Security]     [Netfilter]     [Bugtraq]     [Linux FS]     [Yosemite Forum]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Samba]     [Video 4 Linux]     [Device Mapper]     [Linux Resources]

  Powered by Linux