Re: [PATCH 00/17] Include linux trace docs to Sphinx TOC tree
From: Jonathan Corbet
Date: Wed Mar 07 2018 - 12:46:57 EST
On Tue, 27 Feb 2018 17:43:37 -0500
Steven Rostedt <rostedt@xxxxxxxxxxx> wrote:
> On Tue, 27 Feb 2018 17:34:22 +0800
> "Du, Changbin" <changbin.du@xxxxxxxxx> 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