linux-kernel - [RFC PATCH 0/3] Include linux trace docs to Sphinx TOC tree

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <1518750739-12514-1-git-send-email-changbin.du@intel.com>
Date:   Fri, 16 Feb 2018 11:12:16 +0800
From:   changbin.du@...el.com
To:     corbet@....net, rostedt@...dmis.org, mingo@...nel.org
Cc:     linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
        Changbin Du <changbin.du@...el.com>
Subject: [RFC PATCH 0/3] Include linux trace docs to Sphinx TOC tree

From: Changbin Du <changbin.du@...el.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