Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 762b2935 authored by Franck Bui-Huu's avatar Franck Bui-Huu Committed by Arnaldo Carvalho de Melo
Browse files

perf doc: Allow producing documentation in a specified output directory 

Currently we can put the object files in a different directory by using
'O=' comand line argument.

However the generated documentation files don't honor this directive,

This patch fixes that. It's been tested for man target but the others
seems currently broken so no tests have been done on them so far.

Link: http://lkml.kernel.org/r/1328541443-18003-1-git-send-email-fbuihuu@gmail.com


Signed-off-by: default avatarFranck Bui-Huu <fbuihuu@gmail.com>
Signed-off-by: default avatarArnaldo Carvalho de Melo <acme@redhat.com>
parent e89cef13

tools/perf/Documentation/Makefile

+52 −34
Original line number Original line Diff line number Diff line 
OUTPUT := ./

ifeq ("$(origin O)", "command line")

  ifneq ($(O),)

	OUTPUT := $(O)/

  endif

endif



MAN1_TXT= \

MAN1_TXT= \

	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \

	$(filter-out $(addsuffix .txt, $(ARTICLES) $(SP_ARTICLES)), \

		$(wildcard perf-*.txt)) \

		$(wildcard perf-*.txt)) \
@@ -6,10 +13,11 @@ MAN5_TXT= 
MAN7_TXT=

MAN7_TXT=





MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)

MAN_TXT = $(MAN1_TXT) $(MAN5_TXT) $(MAN7_TXT)

MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))

_MAN_XML=$(patsubst %.txt,%.xml,$(MAN_TXT))

MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))

_MAN_HTML=$(patsubst %.txt,%.html,$(MAN_TXT))





DOC_HTML=$(MAN_HTML)

MAN_XML=$(addprefix $(OUTPUT),$(_MAN_XML))

MAN_HTML=$(addprefix $(OUTPUT),$(_MAN_HTML))





ARTICLES =

ARTICLES =

# with their own formatting rules.

# with their own formatting rules.
@@ -18,11 +26,17 @@ API_DOCS = $(patsubst %.txt,%,$(filter-out technical/api-index-skel.txt technica 
SP_ARTICLES += $(API_DOCS)

SP_ARTICLES += $(API_DOCS)

SP_ARTICLES += technical/api-index

SP_ARTICLES += technical/api-index





DOC_HTML += $(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))

_DOC_HTML = $(_MAN_HTML)

_DOC_HTML+=$(patsubst %,%.html,$(ARTICLES) $(SP_ARTICLES))

DOC_HTML=$(addprefix $(OUTPUT),$(_DOC_HTML))





DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))

_DOC_MAN1=$(patsubst %.txt,%.1,$(MAN1_TXT))

DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))

_DOC_MAN5=$(patsubst %.txt,%.5,$(MAN5_TXT))

DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))

_DOC_MAN7=$(patsubst %.txt,%.7,$(MAN7_TXT))



DOC_MAN1=$(addprefix $(OUTPUT),$(_DOC_MAN1))

DOC_MAN5=$(addprefix $(OUTPUT),$(_DOC_MAN5))

DOC_MAN7=$(addprefix $(OUTPUT),$(_DOC_MAN7))





# Make the path relative to DESTDIR, not prefix

# Make the path relative to DESTDIR, not prefix

ifndef DESTDIR

ifndef DESTDIR
@@ -150,9 +164,9 @@ man1: $(DOC_MAN1) 
man5: $(DOC_MAN5)

man5: $(DOC_MAN5)

man7: $(DOC_MAN7)

man7: $(DOC_MAN7)





info: perf.info perfman.info

info: $(OUTPUT)perf.info $(OUTPUT)perfman.info





pdf: user-manual.pdf

pdf: $(OUTPUT)user-manual.pdf





install: install-man

install: install-man
@@ -166,7 +180,7 @@ install-man: man 




install-info: info

install-info: info

	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)

	$(INSTALL) -d -m 755 $(DESTDIR)$(infodir)

	$(INSTALL) -m 644 perf.info perfman.info $(DESTDIR)$(infodir)

	$(INSTALL) -m 644 $(OUTPUT)perf.info $(OUTPUT)perfman.info $(DESTDIR)$(infodir)

	if test -r $(DESTDIR)$(infodir)/dir; then \

	if test -r $(DESTDIR)$(infodir)/dir; then \

	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\

	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perf.info ;\

	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\

	  $(INSTALL_INFO) --info-dir=$(DESTDIR)$(infodir) perfman.info ;\
@@ -176,7 +190,7 @@ install-info: info 




install-pdf: pdf

install-pdf: pdf

	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)

	$(INSTALL) -d -m 755 $(DESTDIR)$(pdfdir)

	$(INSTALL) -m 644 user-manual.pdf $(DESTDIR)$(pdfdir)

	$(INSTALL) -m 644 $(OUTPUT)user-manual.pdf $(DESTDIR)$(pdfdir)





#install-html: html

#install-html: html

#	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)

#	'$(SHELL_PATH_SQ)' ./install-webdoc.sh $(DESTDIR)$(htmldir)
@@ -189,14 +203,14 @@ install-pdf: pdf 
#

#

# Determine "include::" file references in asciidoc files.

# Determine "include::" file references in asciidoc files.

#

#

doc.dep : $(wildcard *.txt) build-docdep.perl

$(OUTPUT)doc.dep : $(wildcard *.txt) build-docdep.perl

	$(QUIET_GEN)$(RM) $@+ $@ && \

	$(QUIET_GEN)$(RM) $@+ $@ && \

	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \

	$(PERL_PATH) ./build-docdep.perl >$@+ $(QUIET_STDERR) && \

	mv $@+ $@

	mv $@+ $@





-include doc.dep

-include $(OUPTUT)doc.dep





cmds_txt = cmds-ancillaryinterrogators.txt \

_cmds_txt = cmds-ancillaryinterrogators.txt \

	cmds-ancillarymanipulators.txt \

	cmds-ancillarymanipulators.txt \

	cmds-mainporcelain.txt \

	cmds-mainporcelain.txt \

	cmds-plumbinginterrogators.txt \

	cmds-plumbinginterrogators.txt \
@@ -205,32 +219,36 @@ cmds_txt = cmds-ancillaryinterrogators.txt \ 
	cmds-synchelpers.txt \

	cmds-synchelpers.txt \

	cmds-purehelpers.txt \

	cmds-purehelpers.txt \

	cmds-foreignscminterface.txt

	cmds-foreignscminterface.txt

cmds_txt=$(addprefix $(OUTPUT),$(_cmds_txt))





$(cmds_txt): cmd-list.made

$(cmds_txt): $(OUTPUT)cmd-list.made





cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)

$(OUTPUT)cmd-list.made: cmd-list.perl ../command-list.txt $(MAN1_TXT)

	$(QUIET_GEN)$(RM) $@ && \

	$(QUIET_GEN)$(RM) $@ && \

	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \

	$(PERL_PATH) ./cmd-list.perl ../command-list.txt $(QUIET_STDERR) && \

	date >$@

	date >$@





clean:

clean:

	$(RM) *.xml *.xml+ *.html *.html+ *.1 *.5 *.7

	$(RM) $(MAN_XML) $(addsuffix +,$(MAN_XML))

	$(RM) *.texi *.texi+ *.texi++ perf.info perfman.info

	$(RM) $(MAN_HTML) $(addsuffix +,$(MAN_HTML))

	$(RM) howto-index.txt howto/*.html doc.dep

	$(RM) $(DOC_HTML) $(DOC_MAN1) $(DOC_MAN5) $(DOC_MAN7)

	$(RM) technical/api-*.html technical/api-index.txt

	$(RM) $(OUTPUT)*.texi $(OUTPUT)*.texi+ $(OUTPUT)*.texi++

	$(RM) $(cmds_txt) *.made

	$(RM) $(OUTPUT)perf.info $(OUTPUT)perfman.info



	$(RM) $(OUTPUT)howto-index.txt $(OUTPUT)howto/*.html $(OUTPUT)doc.dep

$(MAN_HTML): %.html : %.txt

	$(RM) $(OUTPUT)technical/api-*.html $(OUTPUT)technical/api-index.txt

	$(RM) $(cmds_txt) $(OUTPUT)*.made



$(MAN_HTML): $(OUTPUT)%.html : %.txt

	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \

	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \

	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \

	$(ASCIIDOC) -b xhtml11 -d manpage -f asciidoc.conf \

		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \

		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \

	mv $@+ $@

	mv $@+ $@





%.1 %.5 %.7 : %.xml

$(OUTPUT)%.1 $(OUTPUT)%.5 $(OUTPUT)%.7 : $(OUTPUT)%.xml

	$(QUIET_XMLTO)$(RM) $@ && \

	$(QUIET_XMLTO)$(RM) $@ && \

	xmlto -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<

	xmlto -o $(OUTPUT) -m $(MANPAGE_XSL) $(XMLTO_EXTRA) man $<





%.xml : %.txt

$(OUTPUT)%.xml : %.txt

	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \

	$(QUIET_ASCIIDOC)$(RM) $@+ $@ && \

	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \

	$(ASCIIDOC) -b docbook -d manpage -f asciidoc.conf \

		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \

		$(ASCIIDOC_EXTRA) -aperf_version=$(PERF_VERSION) -o $@+ $< && \
@@ -239,25 +257,25 @@ $(MAN_HTML): %.html : %.txt 
XSLT = docbook.xsl

XSLT = docbook.xsl

XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css

XSLTOPTS = --xinclude --stringparam html.stylesheet docbook-xsl.css





user-manual.html: user-manual.xml

$(OUTPUT)user-manual.html: $(OUTPUT)user-manual.xml

	$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<

	$(QUIET_XSLTPROC)xsltproc $(XSLTOPTS) -o $@ $(XSLT) $<





perf.info: user-manual.texi

$(OUTPUT)perf.info: $(OUTPUT)user-manual.texi

	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ user-manual.texi

	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split -o $@ $(OUTPUT)user-manual.texi





user-manual.texi: user-manual.xml

$(OUTPUT)user-manual.texi: $(OUTPUT)user-manual.xml

	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \

	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \

	$(DOCBOOK2X_TEXI) user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \

	$(DOCBOOK2X_TEXI) $(OUTPUT)user-manual.xml --encoding=UTF-8 --to-stdout >$@++ && \

	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \

	$(PERL_PATH) fix-texi.perl <$@++ >$@+ && \

	rm $@++ && \

	rm $@++ && \

	mv $@+ $@

	mv $@+ $@





user-manual.pdf: user-manual.xml

$(OUTPUT)user-manual.pdf: $(OUTPUT)user-manual.xml

	$(QUIET_DBLATEX)$(RM) $@+ $@ && \

	$(QUIET_DBLATEX)$(RM) $@+ $@ && \

	$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \

	$(DBLATEX) -o $@+ -p /etc/asciidoc/dblatex/asciidoc-dblatex.xsl -s /etc/asciidoc/dblatex/asciidoc-dblatex.sty $< && \

	mv $@+ $@

	mv $@+ $@





perfman.texi: $(MAN_XML) cat-texi.perl

$(OUTPUT)perfman.texi: $(MAN_XML) cat-texi.perl

	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \

	$(QUIET_DB2TEXI)$(RM) $@+ $@ && \

	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \

	($(foreach xml,$(MAN_XML),$(DOCBOOK2X_TEXI) --encoding=UTF-8 \

		--to-stdout $(xml) &&) true) > $@++ && \

		--to-stdout $(xml) &&) true) > $@++ && \
@@ -265,7 +283,7 @@ perfman.texi: $(MAN_XML) cat-texi.perl 
	rm $@++ && \

	rm $@++ && \

	mv $@+ $@

	mv $@+ $@





perfman.info: perfman.texi

$(OUTPUT)perfman.info: $(OUTPUT)perfman.texi

	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi

	$(QUIET_MAKEINFO)$(MAKEINFO) --no-split --no-validate $*.texi





$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml

$(patsubst %.txt,%.texi,$(MAN_TXT)): %.texi : %.xml