kernel-shark: Separate trace-cmd and kernelshark documentations.
Subsystems (2)
PATCH 1/1 kernel-shark: Separate trace-cmd and kernelshark documentations.
KernelShark is going to be a stand alone package, separate from trace-cmd. The code is already in its own directory, but HTML and man page documents are still not separated.
All KernelShark related documentation (HTML and the man page) is moved from Documentation/ to kernel-shark/doc/ directory.
New targets are added to trace-cmd Makefile:
doc_gui - build KernelShrak documentation
doc_gui_clean - clean KernelShrak documentation
install_doc_gui - install KernelShrak documentation
The existing Makefile targets:
doc, doc_clean, install_doc
are modified to work only with trace-cmd documentation.
The new Makefile targets must be used to build and install KernelShark docs.
This change was requested by Bas van Dijk <[email protected]>, to simplify packaging trace-cmd and kernelshark for nixpkgs, as two different packages.
---
Documentation/Makefile | 20 +---
Makefile | 9 +-
.../doc}/HTML/images/kernelshark-logo.svg | 0
.../doc}/HTML/images/kernelshark.jpg | Bin
.../HTML/images/kshark-advance-filter-01.png | Bin
.../HTML/images/kshark-advance-filter-02.png | Bin
.../images/kshark-advance-filter-delete.png | Bin
.../kshark-advance-filter-ext4-events.png | Bin
.../images/kshark-advance-filter-ext4.png | Bin
.../images/kshark-event-filter-dialog.png | Bin
.../doc}/HTML/images/kshark-event-filter.png | Bin
.../doc}/HTML/images/kshark-filter-menu.png | Bin
.../HTML/images/kshark-graph-control-left.png | Bin
.../HTML/images/kshark-graph-control-line.png | Bin
.../images/kshark-graph-control-minus.png | Bin
.../kshark-graph-control-minusminus.png | Bin
.../HTML/images/kshark-graph-control-plus.png | Bin
.../images/kshark-graph-control-plusplus.png | Bin
.../images/kshark-graph-control-right.png | Bin
.../HTML/images/kshark-graph-info-line.png | Bin
.../HTML/images/kshark-graph-plot-area.png | Bin
.../HTML/images/kshark-graph-plot-title.png | Bin
.../doc}/HTML/images/kshark-list-adjust.png | Bin
.../HTML/images/kshark-list-graph-follow.png | Bin
.../HTML/images/kshark-list-info-area.png | Bin
.../doc}/HTML/images/kshark-open.png | Bin
.../doc}/HTML/images/kshark-plot-cpu-1.png | Bin
.../doc}/HTML/images/kshark-plot-cpu-2.png | Bin
.../HTML/images/kshark-plot-cpu-result.png | Bin
.../doc}/HTML/images/kshark-plot-menu.png | Bin
.../kshark-plot-task-measure-preempt.png | Bin
.../HTML/images/kshark-plot-task-measure.png | Bin
.../HTML/images/kshark-plot-task-result.png | Bin
.../HTML/images/kshark-plot-task-select.png | Bin
.../HTML/images/kshark-plot-task-zoom-1.png | Bin
.../doc}/HTML/images/kshark-select-a-1.png | Bin
.../doc}/HTML/images/kshark-select-b-1.png | Bin
.../HTML/images/kshark-task-filter-dialog.png | Bin
.../doc}/HTML/images/kshark-task-filter.png | Bin
.../doc}/HTML/images/kshark-zoom-in-3.png | Bin
.../HTML/images/kshark-zoom-in-select.png | Bin
.../doc}/HTML/index.html | 0
kernel-shark/doc/Makefile | 108 ++++++++++++++++++
.../doc}/kernelshark.1.txt | 0
44 files changed, 117 insertions(+), 20 deletions(-)
rename {Documentation => kernel-shark/doc}/HTML/images/kernelshark-logo.svg (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kernelshark.jpg (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-advance-filter-01.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-advance-filter-02.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-advance-filter-delete.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-advance-filter-ext4-events.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-advance-filter-ext4.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-event-filter-dialog.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-event-filter.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-filter-menu.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-left.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-line.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-minus.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-minusminus.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-plus.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-plusplus.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-control-right.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-info-line.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-plot-area.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-graph-plot-title.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-list-adjust.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-list-graph-follow.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-list-info-area.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-open.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-cpu-1.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-cpu-2.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-cpu-result.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-menu.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-task-measure-preempt.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-task-measure.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-task-result.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-task-select.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-plot-task-zoom-1.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-select-a-1.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-select-b-1.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-task-filter-dialog.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-task-filter.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-zoom-in-3.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/images/kshark-zoom-in-select.png (100%)
rename {Documentation => kernel-shark/doc}/HTML/index.html (100%)
create mode 100644 kernel-shark/doc/Makefile
rename {Documentation => kernel-shark/doc}/kernelshark.1.txt (100%)Documentation/Makefile +1 -19
@@ -90,25 +90,7 @@ $(MAN1_INSTALL): %.1.install : %.1 force $(MAN5_INSTALL): %.5.install : %.5 force $(Q)$(call do_install_data,$<,$(man_dir_SQ)/man5) -html_dir = $(src)/HTML -image_dir = $(html_dir)/images - -HTML = $(wildcard $(html_dir)/*.html) -IMGS = $(wildcard $(image_dir)/*.png) - -HTML_INSTALL = $(subst .html,.html.install,$(HTML)) -IMGS_INSTALL = $(subst .png,.png.install,$(IMGS)) - -$(HTML_INSTALL): %.html.install : %.html force - $(Q)$(call do_install_data,$<,'$(html_install_SQ)') - -$(IMGS_INSTALL): %.png.install : %.png force - $(Q)$(call do_install_data,$<,'$(img_install_SQ)') - - -GUI_INSTALL = $(HTML_INSTALL) $(IMGS_INSTALL) - -install: $(MAN1_INSTALL) $(MAN5_INSTALL) $(GUI_INSTALL) +install: $(MAN1_INSTALL) $(MAN5_INSTALL) clean: (cd $(obj); \
Makefile +8 -1
@@ -174,7 +174,7 @@ obj := $(objtree) kshark-dir = $(src)/kernel-shark -export prefix bindir src obj +export prefix bindir src obj kshark-dir LIBS = -ldl
@@ -356,12 +356,19 @@ install_libs: libs doc: $(MAKE) -C $(src)/Documentation all +doc_gui: + $(MAKE) -C $(kshark-dir)/doc all + doc_clean: $(MAKE) -C $(src)/Documentation clean +doc_gui_clean: + $(MAKE) -C $(kshark-dir)/doc clean install_doc: $(MAKE) -C $(src)/Documentation install +install_doc_gui: + $(MAKE) -C $(kshark-dir)/doc install clean: $(RM) *.o *~ *.a *.so .*.d
kernel-shark/doc/HTML/images/kernelshark-logo.svg renamed from Documentation/HTML/images/kernelshark-logo.svg +0 -0
kernel-shark/doc/HTML/images/kernelshark.jpg renamed from Documentation/HTML/images/kernelshark.jpg +0 -0
kernel-shark/doc/HTML/images/kshark-advance-filter-01.png renamed from Documentation/HTML/images/kshark-advance-filter-01.png +0 -0
kernel-shark/doc/HTML/images/kshark-advance-filter-02.png renamed from Documentation/HTML/images/kshark-advance-filter-02.png +0 -0
kernel-shark/doc/HTML/images/kshark-advance-filter-delete.png renamed from Documentation/HTML/images/kshark-advance-filter-delete.png +0 -0
kernel-shark/doc/HTML/images/kshark-advance-filter-ext4-events.png renamed from Documentation/HTML/images/kshark-advance-filter-ext4-events.png +0 -0
kernel-shark/doc/HTML/images/kshark-advance-filter-ext4.png renamed from Documentation/HTML/images/kshark-advance-filter-ext4.png +0 -0
kernel-shark/doc/HTML/images/kshark-event-filter-dialog.png renamed from Documentation/HTML/images/kshark-event-filter-dialog.png +0 -0
kernel-shark/doc/HTML/images/kshark-event-filter.png renamed from Documentation/HTML/images/kshark-event-filter.png +0 -0
kernel-shark/doc/HTML/images/kshark-filter-menu.png renamed from Documentation/HTML/images/kshark-filter-menu.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-left.png renamed from Documentation/HTML/images/kshark-graph-control-left.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-line.png renamed from Documentation/HTML/images/kshark-graph-control-line.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-minus.png renamed from Documentation/HTML/images/kshark-graph-control-minus.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-minusminus.png renamed from Documentation/HTML/images/kshark-graph-control-minusminus.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-plus.png renamed from Documentation/HTML/images/kshark-graph-control-plus.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-plusplus.png renamed from Documentation/HTML/images/kshark-graph-control-plusplus.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-control-right.png renamed from Documentation/HTML/images/kshark-graph-control-right.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-info-line.png renamed from Documentation/HTML/images/kshark-graph-info-line.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-plot-area.png renamed from Documentation/HTML/images/kshark-graph-plot-area.png +0 -0
kernel-shark/doc/HTML/images/kshark-graph-plot-title.png renamed from Documentation/HTML/images/kshark-graph-plot-title.png +0 -0
kernel-shark/doc/HTML/images/kshark-list-adjust.png renamed from Documentation/HTML/images/kshark-list-adjust.png +0 -0
kernel-shark/doc/HTML/images/kshark-list-graph-follow.png renamed from Documentation/HTML/images/kshark-list-graph-follow.png +0 -0
kernel-shark/doc/HTML/images/kshark-list-info-area.png renamed from Documentation/HTML/images/kshark-list-info-area.png +0 -0
kernel-shark/doc/HTML/images/kshark-open.png renamed from Documentation/HTML/images/kshark-open.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-cpu-1.png renamed from Documentation/HTML/images/kshark-plot-cpu-1.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-cpu-2.png renamed from Documentation/HTML/images/kshark-plot-cpu-2.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-cpu-result.png renamed from Documentation/HTML/images/kshark-plot-cpu-result.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-menu.png renamed from Documentation/HTML/images/kshark-plot-menu.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-task-measure-preempt.png renamed from Documentation/HTML/images/kshark-plot-task-measure-preempt.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-task-measure.png renamed from Documentation/HTML/images/kshark-plot-task-measure.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-task-result.png renamed from Documentation/HTML/images/kshark-plot-task-result.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-task-select.png renamed from Documentation/HTML/images/kshark-plot-task-select.png +0 -0
kernel-shark/doc/HTML/images/kshark-plot-task-zoom-1.png renamed from Documentation/HTML/images/kshark-plot-task-zoom-1.png +0 -0
kernel-shark/doc/HTML/images/kshark-select-a-1.png renamed from Documentation/HTML/images/kshark-select-a-1.png +0 -0
kernel-shark/doc/HTML/images/kshark-select-b-1.png renamed from Documentation/HTML/images/kshark-select-b-1.png +0 -0
kernel-shark/doc/HTML/images/kshark-task-filter-dialog.png renamed from Documentation/HTML/images/kshark-task-filter-dialog.png +0 -0
kernel-shark/doc/HTML/images/kshark-task-filter.png renamed from Documentation/HTML/images/kshark-task-filter.png +0 -0
kernel-shark/doc/HTML/images/kshark-zoom-in-3.png renamed from Documentation/HTML/images/kshark-zoom-in-3.png +0 -0
kernel-shark/doc/HTML/images/kshark-zoom-in-select.png renamed from Documentation/HTML/images/kshark-zoom-in-select.png +0 -0
kernel-shark/doc/HTML/index.html renamed from Documentation/HTML/index.html +0 -0
kernel-shark/doc/Makefile new file +108 -0
108 lines not on this page · raw message
kernel-shark/doc/kernelshark.1.txt renamed from Documentation/kernelshark.1.txt +0 -0
Signature · 1 line
2.21.0
Quoted 18 lines · On Thu, 1 Aug 2019 15:19:55 +0300 "Tzvetomir Stoyanov (VMware)"…
KernelShark is going to be a stand alone package, separate from trace-cmd. The code is already in its own directory, but HTML and man page documents are still not separated.
All KernelShark related documentation (HTML and the man page) is moved fromDocumentation/to kernel-shark/doc/ directory.
New targets are added to trace-cmdMakefile:
doc_gui- build KernelShrak documentation
doc_gui_clean- clean KernelShrak documentation
install_doc_gui- install KernelShrak documentation
The existingMakefiletargets:
doc,doc_clean,install_doc
are modified to work only with trace-cmd documentation.
The newMakefiletargets must be used to build and install KernelShark docs.This change was requested by Bas van Dijk <[email protected]>, to simplify packaging trace-cmd and kernelshark for nixpkgs, as two different packages.
Quoted 5 lines
Signed-off-by Tzvetomir Stoyanov (VMware) <[email protected]>---
rename {Documentation => kernel-shark/doc}/HTML/images/kernelshark-logo.svg (100%)
When I first saw this, I questioned moving this out of Documentation. But thinking about it more, it does make sense.
But can I ask you to keep the "Documentation" name?
It just seems more professional, and also stays in line with the trace-cmd and Linux kernel "Documentation" directory name.
Thanks!
-- Steve
Quoted 27 lines · Steven Rostedt
Quoted 18 lines · On Thu, 1 Aug 2019 15:19:55 +0300 "Tzvetomir Stoyanov (VMware)"…
KernelShark is going to be a stand alone package, separate from trace-cmd. The code is already in its own directory, but HTML and man page documents are still not separated.
All KernelShark related documentation (HTML and the man page) is moved fromDocumentation/to kernel-shark/doc/ directory.
New targets are added to trace-cmdMakefile:
doc_gui- build KernelShrak documentation
doc_gui_clean- clean KernelShrak documentationinstall_doc_gui- install KernelShrak documentation
The existingMakefiletargets:
doc,doc_clean,install_doc
are modified to work only with trace-cmd documentation.
The newMakefiletargets must be used to build and install KernelShark docs.This change was requested by Bas van Dijk <[email protected]>, to simplify packaging trace-cmd and kernelshark for nixpkgs, as two different packages.
Quoted 5 lines
Signed-off-by Tzvetomir Stoyanov (VMware) <[email protected]>---
rename {Documentation => kernel-shark/doc}/HTML/images/kernelshark-logo.svg (100%)
Quoted 7 lines
When I first saw this, I questioned moving this out of Documentation. But thinking about it more, it does make sense.
But can I ask you to keep the "Documentation" name?
It just seems more professional, and also stays in line with the trace-cmd and Linux kernel "Documentation" directory name.
I agree. Let's rename kernel-shark/doc to kernel-shark/Documentation.
Thanks!
Yordan
Quoted 5 lines
Thanks!
-- Steve