xref: /aosp_15_r20/external/trace-cmd/Documentation/libtracecmd/Makefile (revision 58e6ee5f017f6a8912852c892d18457e4bafb554)
1# SPDX-License-Identifier: GPL-2.0
2
3# Include the utils
4include $(src)/scripts/utils.mk
5
6# This Makefile and manpage XSL files were taken from libtracefs
7# and modified for libtracecmd
8
9MAN3_TXT= \
10	$(wildcard libtracecmd-*.txt) \
11	libtracecmd.txt
12
13MAN_TXT = $(MAN3_TXT)
14_MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))
15_MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))
16_DOC_MAN3=$(patsubst %.txt,%.m,$(MAN3_TXT))
17
18MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))
19MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))
20DOC_MAN3=$(addprefix $(OUTPUT),$(_DOC_MAN3))
21
22# Make the path relative to DESTDIR, not prefix
23ifndef DESTDIR
24prefix?=$(HOME)
25endif
26bindir?=$(prefix)/bin
27htmldir?=$(prefix)/share/doc/libtracecmd-doc
28pdfdir?=$(prefix)/share/doc/libtracecmd-doc
29mandir?=$(prefix)/share/man
30man3dir=$(mandir)/man3
31
32ifdef USE_ASCIIDOCTOR
33ASCIIDOC_EXTRA += -a mansource="libtracecmd" -a manmanual="libtracecmd Manual"
34endif
35
36all: check-man-tools html man
37
38man: man3
39man3: $(DOC_MAN3)
40
41html: $(MAN_HTML)
42
43$(MAN_HTML) $(DOC_MAN3): $(ASCIIDOC_CONF)
44
45install: check-man-tools install-man install-html
46
47check-man-tools:
48ifdef missing_tools
49	$(error "You need to install $(missing_tools) for man pages")
50endif
51
52install-%.3: $(OUTPUT)%.3
53	$(Q)$(call do_install_docs,$<,$(man3dir),644);
54
55do-install-man: man $(addprefix install-,$(wildcard $(OUTPUT)*.3))
56
57install-man: man
58	$(Q)$(MAKE) -C . do-install-man
59
60install-%.txt: $(OUTPUT)%.html
61	$(Q)$(call do_install_docs,$<,$(htmldir),644);
62
63do-install-html: html $(addprefix install-,$(wildcard *.txt))
64
65install-html: html do-install-html
66
67uninstall: uninstall-man uninstall-html
68
69uninstall-man:
70	$(Q)$(RM) $(addprefix $(DESTDIR)$(man3dir)/,$(DOC_MAN3))
71
72uninstall-html:
73	$(Q)$(RM) $(addprefix $(DESTDIR)$(htmldir)/,$(MAN_HTML))
74
75ifdef missing_tools
76  DO_INSTALL_MAN = $(warning Please install $(missing_tools) to have the man pages installed)
77else
78  DO_INSTALL_MAN = do-install-man
79endif
80
81CLEAN_FILES =					\
82	$(MAN_XML) $(addsuffix +,$(MAN_XML))	\
83	$(MAN_HTML) $(addsuffix +,$(MAN_HTML))	\
84	$(DOC_MAN3) *.3 *.m
85
86clean:
87	$(Q) $(RM) $(CLEAN_FILES)
88
89ifdef USE_ASCIIDOCTOR
90$(OUTPUT)%.m : $(OUTPUT)%.txt
91	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
92	$(ASCIIDOC) -b manpage -d manpage \
93		$(ASCIIDOC_EXTRA) -alibtracecmd_version=$(LIBTRACECMD_VERSION) -o $@+ $< && \
94	mv $@+ $@
95endif
96
97$(OUTPUT)%.m : $(OUTPUT)%.xml
98	$(QUIET_XMLTO)$(RM) $@ && \
99	$(XMLTO) -o $(OUTPUT). -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<; \
100	touch $@
101
102$(OUTPUT)%.xml : %.txt
103	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
104	$(ASCIIDOC) -b docbook -d manpage \
105		$(ASCIIDOC_EXTRA) -alibtracecmd_version=$(LIBTRACECMD_VERSION) -o $@+ $< && \
106	mv $@+ $@
107
108$(MAN_HTML): $(OUTPUT)%.html : %.txt
109	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \
110	$(ASCIIDOC) -b $(ASCIIDOC_HTML) -d manpage \
111		$(ASCIIDOC_EXTRA) -alibtracecmd_version=$(LIBTRACECMD_VERSION) -o $@+ $< && \
112	mv $@+ $@
113