From: Masami Hiramatsu (Google) <mhiramat@kernel.org>
To: Yoann Congal <yoann.congal@smile.fr>
Cc: Steven Rostedt <rostedt@goodmis.org>,
linux-doc@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>,
Masami Hiramatsu <mhiramat@kernel.org>,
Bagas Sanjaya <bagasdotme@gmail.com>
Subject: Re: [PATCH RESEND] Documentation: kprobetrace: Improve readability
Date: Sun, 25 Sep 2022 10:48:46 +0900 [thread overview]
Message-ID: <20220925104846.630cd22a3f82e69770eb365a@kernel.org> (raw)
In-Reply-To: <fa0bb78c-c0c3-bea5-45b1-460b0754e369@smile.fr>
On Sat, 24 Sep 2022 15:32:29 +0200
Yoann Congal <yoann.congal@smile.fr> 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@smile.fr> 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@smile.fr> ---
> >>>> 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@kernel.org>
next prev parent reply other threads:[~2022-09-25 1:48 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-15 15:33 [PATCH RESEND] Documentation: kprobetrace: Improve readability Yoann Congal
2022-09-21 20:20 ` Jonathan Corbet
2022-09-22 2:13 ` Bagas Sanjaya
2022-09-22 2:47 ` Steven Rostedt
2022-09-24 13:32 ` Yoann Congal
2022-09-25 1:48 ` Masami Hiramatsu [this message]
2022-09-26 14:45 ` Steven Rostedt
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20220925104846.630cd22a3f82e69770eb365a@kernel.org \
--to=mhiramat@kernel.org \
--cc=bagasdotme@gmail.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=rostedt@goodmis.org \
--cc=yoann.congal@smile.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).