From: "Du, Changbin" <changbin.du@intel.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Steven Rostedt <rostedt@goodmis.org>,
"Du, Changbin" <changbin.du@intel.com>,
mingo@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 00/17] Include linux trace docs to Sphinx TOC tree
Date: Thu, 8 Mar 2018 10:42:07 +0800 [thread overview]
Message-ID: <20180308024207.x7mxbo75gtk433is@intel.com> (raw)
In-Reply-To: <20180307104649.4db521a5@lwn.net>
On Wed, Mar 07, 2018 at 10:46:49AM -0700, Jonathan Corbet wrote:
> On Tue, 27 Feb 2018 17:43:37 -0500
> Steven Rostedt <rostedt@goodmis.org> wrote:
>
> > On Tue, 27 Feb 2018 17:34:22 +0800
> > "Du, Changbin" <changbin.du@intel.com> wrote:
> >
> > > Ten days past, will you accept this serias? Thank you!
> >
> > Currently I'm very overloaded with other code that needs to get done
> > ASAP, and I need to balance what is critical and what is not. I don't
> > have time to review this, as this isn't critical, and can wait.
> >
> > If Jon can review it to make sure that it doesn't change the
> > readability of the text, then I'll trust his judgment.
>
> So I've spent a while working through the patches. I think it's a
> well-done RST conversion carried out with a light hand; I do not believe
> there are any readability issues with the resulting text files.
>
> I will note that the series adds some new build warnings:
>
> > Documentation/trace/events.rst:45: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:49: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:193: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:114: WARNING: Unknown target name: "common".
> > Documentation/trace/ftrace.rst:2620: WARNING: Inline emphasis start-string without end-string.
>
> These point to places where the resulting formatted docs are, in fact,
> incorrect. I had to append the attached patch to the series to make those
> problems go away. The warnings are there for a purpose!
>
> Anyway, with that, the patch series is applied. Thanks for helping to
> improve the docs, and my apologies for taking so long to get to this.
>
> jon
>
I am also appriciated for your review. And I am glade to see these docs can appear
in the new beautiful html documentation! Thnak you.
- changbin
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
WARNING: multiple messages have this Message-ID (diff)
From: "Du, Changbin" <changbin.du@intel.com>
To: Jonathan Corbet <corbet@lwn.net>
Cc: Steven Rostedt <rostedt@goodmis.org>,
"Du, Changbin" <changbin.du@intel.com>,
mingo@kernel.org, linux-doc@vger.kernel.org,
linux-kernel@vger.kernel.org
Subject: Re: [PATCH 00/17] Include linux trace docs to Sphinx TOC tree
Date: Thu, 8 Mar 2018 10:42:07 +0800 [thread overview]
Message-ID: <20180308024207.x7mxbo75gtk433is@intel.com> (raw)
In-Reply-To: <20180307104649.4db521a5@lwn.net>
On Wed, Mar 07, 2018 at 10:46:49AM -0700, Jonathan Corbet wrote:
> On Tue, 27 Feb 2018 17:43:37 -0500
> Steven Rostedt <rostedt@goodmis.org> wrote:
>
> > On Tue, 27 Feb 2018 17:34:22 +0800
> > "Du, Changbin" <changbin.du@intel.com> wrote:
> >
> > > Ten days past, will you accept this serias? Thank you!
> >
> > Currently I'm very overloaded with other code that needs to get done
> > ASAP, and I need to balance what is critical and what is not. I don't
> > have time to review this, as this isn't critical, and can wait.
> >
> > If Jon can review it to make sure that it doesn't change the
> > readability of the text, then I'll trust his judgment.
>
> So I've spent a while working through the patches. I think it's a
> well-done RST conversion carried out with a light hand; I do not believe
> there are any readability issues with the resulting text files.
>
> I will note that the series adds some new build warnings:
>
> > Documentation/trace/events.rst:45: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:49: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:193: WARNING: Inline emphasis start-string without end-string.
> > Documentation/trace/events.rst:114: WARNING: Unknown target name: "common".
> > Documentation/trace/ftrace.rst:2620: WARNING: Inline emphasis start-string without end-string.
>
> These point to places where the resulting formatted docs are, in fact,
> incorrect. I had to append the attached patch to the series to make those
> problems go away. The warnings are there for a purpose!
>
> Anyway, with that, the patch series is applied. Thanks for helping to
> improve the docs, and my apologies for taking so long to get to this.
>
> jon
>
I am also appriciated for your review. And I am glade to see these docs can appear
in the new beautiful html documentation! Thnak you.
- changbin
next prev parent reply other threads:[~2018-03-08 2:51 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-17 5:39 [PATCH 00/17] Include linux trace docs to Sphinx TOC tree changbin.du
2018-02-17 5:39 ` [PATCH 01/17] Documentation: add Linux tracing " changbin.du
2018-02-17 5:39 ` [PATCH 02/17] trace doc: convert trace/ftrace-design.txt to rst format changbin.du
2018-02-17 5:39 ` [PATCH 03/17] trace doc: add ftrace-uses.rst to doc tree changbin.du
2018-02-17 5:39 ` [PATCH 04/17] trace doc: convert trace/tracepoint-analysis.txt to rst format changbin.du
2018-02-17 5:39 ` [PATCH 05/17] trace doc: convert trace/ftrace.txt " changbin.du
2018-02-20 7:28 ` Philippe Ombredanne
2018-02-20 13:27 ` Du, Changbin
2018-02-20 15:26 ` Steven Rostedt
2018-02-20 16:36 ` Jonathan Corbet
2018-02-17 5:39 ` [PATCH 06/17] trace doc: convert trace/kprobetrace.txt " changbin.du
2018-02-17 5:39 ` [PATCH 07/17] trace doc: convert trace/uprobetracer.txt " changbin.du
2018-02-17 5:39 ` [PATCH 08/17] trace doc: convert trace/tracepoints.txt " changbin.du
2018-02-17 5:39 ` [PATCH 09/17] trace doc: convert trace/events.txt " changbin.du
2018-02-17 5:39 ` [PATCH 10/17] trace doc: convert trace/events-kmem.txt " changbin.du
2018-02-17 5:39 ` [PATCH 11/17] trace doc: convert trace/events-power.txt " changbin.du
2018-02-17 5:39 ` [PATCH 12/17] trace doc: convert trace/events-nmi.txt " changbin.du
2018-02-17 5:39 ` [PATCH 13/17] trace doc: convert trace/events-msr.txt " changbin.du
2018-02-17 5:39 ` [PATCH 14/17] trace doc: convert trace/mmiotrace.txt " changbin.du
2018-02-17 5:39 ` [PATCH 15/17] trace doc: convert trace/hwlat_detector.txt to rst fromat changbin.du
2018-02-17 5:39 ` [PATCH 16/17] trace doc: convert trace/intel_th.txt to rst format changbin.du
2018-02-17 5:39 ` [PATCH 17/17] trace doc: convert trace/stm.txt " changbin.du
2018-02-27 9:34 ` [PATCH 00/17] Include linux trace docs to Sphinx TOC tree Du, Changbin
2018-02-27 22:43 ` Steven Rostedt
2018-03-07 17:46 ` Jonathan Corbet
2018-03-07 17:46 ` Jonathan Corbet
2018-03-08 2:42 ` Du, Changbin [this message]
2018-03-08 2:42 ` Du, Changbin
2018-03-08 3:41 ` Steven Rostedt
2018-03-08 3:41 ` 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=20180308024207.x7mxbo75gtk433is@intel.com \
--to=changbin.du@intel.com \
--cc=corbet@lwn.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mingo@kernel.org \
--cc=rostedt@goodmis.org \
/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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.