Skip to content

Include linux trace docs to Sphinx TOC tree

[email protected] linux-doc lkml 1 version In review

Get series with b4
b4 am [email protected]

Versions newest first

  1. v1 Latest17 patches 9 repliesIn review

Patches in v1 No applies recorded yet

#Subject and filesSizeRepliesApplied
1/17Documentation: add Linux tracing to Sphinx TOC treeDocumentation/index.rst Documentation/trace/index.rst+7 -00 replies
2/17trace doc: convert trace/ftrace-design.txt to rst formatDocumentation/trace/ftrace-design.rst Documentation/trace/index.rst+141 -1130 replies
3/17trace doc: add ftrace-uses.rst to doc treeDocumentation/trace/ftrace-uses.rst Documentation/trace/index.rst+13 -110 replies
4/17trace doc: convert trace/tracepoint-analysis.txt to rst formatDocumentation/trace/index.rst Documentation/trace/tracepoint-analysis.rst+27 -150 replies
5/17trace doc: convert trace/ftrace.txt to rst formatDocumentation/trace/ftrace.rst Documentation/trace/ftrace.txt Documentation/trace/index.rst+3333 -32204 replies
6/17trace doc: convert trace/kprobetrace.txt to rst formatDocumentation/trace/index.rst Documentation/trace/kprobetrace.rst+55 -460 replies
7/17trace doc: convert trace/uprobetracer.txt to rst formatDocumentation/trace/index.rst Documentation/trace/uprobetracer.rst+27 -180 replies
8/17trace doc: convert trace/tracepoints.txt to rst formatDocumentation/trace/index.rst Documentation/trace/tracepoints.rst+41 -370 replies
9/17trace doc: convert trace/events.txt to rst formatDocumentation/trace/events.rst Documentation/trace/index.rst+337 -3330 replies
10/17trace doc: convert trace/events-kmem.txt to rst formatDocumentation/trace/events-kmem.rst Documentation/trace/index.rst+32 -190 replies
11/17trace doc: convert trace/events-power.txt to rst formatDocumentation/trace/events-power.rst Documentation/trace/index.rst+31 -220 replies
12/17trace doc: convert trace/events-nmi.txt to rst formatDocumentation/trace/events-nmi.rst Documentation/trace/events-nmi.txt Documentation/trace/index.rst+46 -430 replies
13/17trace doc: convert trace/events-msr.txt to rst formatDocumentation/trace/events-msr.rst Documentation/trace/events-msr.txt Documentation/trace/index.rst+41 -370 replies
14/17trace doc: convert trace/mmiotrace.txt to rst formatDocumentation/trace/index.rst Documentation/trace/mmiotrace.rst+54 -330 replies
15/17trace doc: convert trace/hwlat_detector.txt to rst fromatDocumentation/trace/hwlat_detector.rst Documentation/trace/index.rst+16 -110 replies
16/17trace doc: convert trace/intel_th.txt to rst formatDocumentation/trace/index.rst Documentation/trace/intel_th.rst+23 -210 replies
17/17trace doc: convert trace/stm.txt to rst formatDocumentation/trace/index.rst Documentation/trace/stm.rst+13 -110 replies

Reviews trailers per patch

No Reviewed-by, Acked-by or Tested-by trailers for v1 yet.

Read the v1 thread

Cover letter [PATCH 00/17] Include linux trace docs to Sphinx TOC tree

From: Changbin Du <[email protected]>

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 most of the Linux trace docs to rst format in this serias.

For you to preview, please visit below url:
http://docservice.askxiong.com/linux-kernel/trace/index.html

Thank you!

Changbin Du (17):
Documentation: add Linux tracing to Sphinx TOC tree trace doc: convert trace/ftrace-design.txt to rst format trace doc: add ftrace-uses.rst to doc tree
trace doc: convert trace/tracepoint-analysis.txt to rst format trace doc: convert trace/ftrace.txt to rst format trace doc: convert trace/kprobetrace.txt to rst format trace doc: convert trace/uprobetracer.txt to rst format trace doc: convert trace/tracepoints.txt to rst format trace doc: convert trace/events.txt to rst format trace doc: convert trace/events-kmem.txt to rst format trace doc: convert trace/events-power.txt to rst format trace doc: convert trace/events-nmi.txt to rst format trace doc: convert trace/events-msr.txt to rst format trace doc: convert trace/mmiotrace.txt to rst format trace doc: convert trace/hwlat_detector.txt to rst fromat trace doc: convert trace/intel_th.txt to rst format trace doc: convert trace/stm.txt to rst format

 Documentation/index.rst                            |    1 +
 .../trace/{events-kmem.txt => events-kmem.rst}     |   50 +-
 Documentation/trace/events-msr.rst                 |   40 +
 Documentation/trace/events-msr.txt                 |   37 -
 Documentation/trace/events-nmi.rst                 |   45 +
 Documentation/trace/events-nmi.txt                 |   43 -
 .../trace/{events-power.txt => events-power.rst}   |   52 +-
 Documentation/trace/{events.txt => events.rst}     |  669 ++--
 .../trace/{ftrace-design.txt => ftrace-design.rst} |  252 +-
 Documentation/trace/ftrace-uses.rst                |   23 +-
 Documentation/trace/ftrace.rst                     | 3332 ++++++++++++++++++++
 Documentation/trace/ftrace.txt                     | 3220 -------------------
 .../{hwlat_detector.txt => hwlat_detector.rst}     |   26 +-
 Documentation/trace/index.rst                      |   23 +
 Documentation/trace/{intel_th.txt => intel_th.rst} |   43 +-
 .../trace/{kprobetrace.txt => kprobetrace.rst}     |  100 +-
 .../trace/{mmiotrace.txt => mmiotrace.rst}         |   86 +-
 Documentation/trace/{stm.txt => stm.rst}           |   23 +-
 ...epoint-analysis.txt => tracepoint-analysis.rst} |   41 +-
 .../trace/{tracepoints.txt => tracepoints.rst}     |   77 +-
 .../trace/{uprobetracer.txt => uprobetracer.rst}   |   44 +-
 21 files changed, 4237 insertions(+), 3990 deletions(-)
 rename Documentation/trace/{events-kmem.txt => events-kmem.rst} (76%)
 create mode 100644 Documentation/trace/events-msr.rst
 delete mode 100644 Documentation/trace/events-msr.txt
 create mode 100644 Documentation/trace/events-nmi.rst
 delete mode 100644 Documentation/trace/events-nmi.txt
 rename Documentation/trace/{events-power.txt => events-power.rst} (65%)
 rename Documentation/trace/{events.txt => events.rst} (82%)
 rename Documentation/trace/{ftrace-design.txt => ftrace-design.rst} (74%)
 create mode 100644 Documentation/trace/ftrace.rst
 delete mode 100644 Documentation/trace/ftrace.txt
 rename Documentation/trace/{hwlat_detector.txt => hwlat_detector.rst} (83%)
 create mode 100644 Documentation/trace/index.rst
 rename Documentation/trace/{intel_th.txt => intel_th.rst} (82%)
 rename Documentation/trace/{kprobetrace.txt => kprobetrace.rst} (63%)
 rename Documentation/trace/{mmiotrace.txt => mmiotrace.rst} (78%)
 rename Documentation/trace/{stm.txt => stm.rst} (91%)
 rename Documentation/trace/{tracepoint-analysis.txt => tracepoint-analysis.rst} (93%)
 rename Documentation/trace/{tracepoints.txt => tracepoints.rst} (74%)
 rename Documentation/trace/{uprobetracer.txt => uprobetracer.rst} (86%)
Signature · 1 line
2.7.4