From: changbin.du@intel.com
To: corbet@lwn.net, rostedt@goodmis.org, mingo@kernel.org
Cc: linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
Changbin Du <changbin.du@intel.com>
Subject: [RFC PATCH 0/3] Include linux trace docs to Sphinx TOC tree
Date: Fri, 16 Feb 2018 11:12:16 +0800 [thread overview]
Message-ID: <1518750739-12514-1-git-send-email-changbin.du@intel.com> (raw)
From: Changbin Du <changbin.du@intel.com>
Hi All,
The linux tracers are so useful that I want to make the docs better. The kernel
now uses Sphinx to generate intelligent and beautiful documentation from
reStructuredText files. I converted two trace docs for your to preview.
http://docservice.askxiong.com/linux-kernel/trace/index.html
If this looks good then I will do reset rest docs for trace. Please give
feedbacks. Thank you!
Changbin Du (3):
Documentation: add tracing to Sphinx TOC tree
Documentation: convert trace/ftrace-design.txt to rst format
Documentation: add ftrace-uses.rst to doc tree
Documentation/index.rst | 1 +
.../trace/{ftrace-design.txt => ftrace-design.rst} | 248 +++++++++++----------
Documentation/trace/ftrace-uses.rst | 23 +-
Documentation/trace/index.rst | 9 +
4 files changed, 157 insertions(+), 124 deletions(-)
rename Documentation/trace/{ftrace-design.txt => ftrace-design.rst} (75%)
create mode 100644 Documentation/trace/index.rst
--
2.7.4
next reply other threads:[~2018-02-16 3:21 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-02-16 3:12 changbin.du [this message]
2018-02-16 3:12 ` [PATCH 1/3] Documentation: add tracing " changbin.du
2018-02-16 3:12 ` [PATCH 2/3] Documentation: convert trace/ftrace-design.txt to rst format changbin.du
2018-02-16 3:57 ` Steven Rostedt
2018-02-16 9:07 ` Du, Changbin
2018-02-16 17:32 ` Steven Rostedt
2018-02-16 12:49 ` Jonathan Corbet
2018-02-16 17:36 ` Steven Rostedt
2018-02-17 3:30 ` Du, Changbin
2018-02-16 3:12 ` [PATCH 3/3] Documentation: add ftrace-uses.rst to doc tree changbin.du
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=1518750739-12514-1-git-send-email-changbin.du@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
all inboxes | Powered by JetHome®