diff options
author | Lukas Larsson <lukas@erlang.org> | 2020-01-30 16:10:22 +0100 |
---|---|---|
committer | Lukas Larsson <lukas@erlang.org> | 2020-02-24 09:52:59 +0100 |
commit | 043a1ae7a4c14ead443884aaa57995d852d2a9e7 (patch) | |
tree | 0d047773bb171bcc67defe81c339503eec6210ee /lib/common_test | |
parent | e58cf21c13b69b12211543d493d236f51103c0af (diff) | |
download | erlang-043a1ae7a4c14ead443884aaa57995d852d2a9e7.tar.gz |
otp: Refactor doc make system and introduce EEP-48
Diffstat (limited to 'lib/common_test')
-rw-r--r-- | lib/common_test/doc/src/Makefile | 89 | ||||
-rw-r--r-- | lib/common_test/doc/src/ct_run_cmd.xml (renamed from lib/common_test/doc/src/ct_run.xml) | 3 | ||||
-rw-r--r-- | lib/common_test/doc/src/ref_man.xml | 2 |
3 files changed, 5 insertions, 89 deletions
diff --git a/lib/common_test/doc/src/Makefile b/lib/common_test/doc/src/Makefile index ae06572752..55ab5e5cc1 100644 --- a/lib/common_test/doc/src/Makefile +++ b/lib/common_test/doc/src/Makefile @@ -27,10 +27,6 @@ include $(ERL_TOP)/make/$(TARGET)/otp.mk include ../../vsn.mk VSN=$(COMMON_TEST_VSN) APPLICATION=common_test -# ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) # ---------------------------------------------------- # Target Specs @@ -39,7 +35,7 @@ RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) CT_XML_FILES = $(CT_MODULES:=.xml) XML_APPLICATION_FILES = ref_man.xml -XML_REF1_FILES = ct_run.xml +XML_REF1_FILES = ct_run_cmd.xml # REMEMBER: links to HTML files for these modules in ref_man.xml XML_REF3_FILES = ct.xml \ ct_master.xml \ @@ -80,95 +76,16 @@ XML_CHAPTER_FILES = \ BOOK_FILES = book.xml -GIF_FILES = \ +IMAGE_FILES = \ tc_execution.gif \ config.gif \ html_logs.gif -INSTALL_NOTES = ../../notes.html - XML_FILES=$(XML_APPLICATION_FILES) $(XML_REF1_FILES) $(XML_REF3_FILES) $(XML_REF6_FILES) \ $(XML_PART_FILES) $(XML_CHAPTER_FILES) $(BOOK_FILES) -# ---------------------------------------------------- - -HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) - -INFO_FILE = ../../info - -MAN1_FILES = $(XML_REF1_FILES:%.xml=$(MAN1DIR)/%.1) -MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) -MAN6_FILES = $(XML_REF6_FILES:%_app.xml=$(MAN6DIR)/%.6) - -HTML_REF_MAN_FILE = $(HTMLDIR)/index.html - -TOP_PDF_FILE = $(PDFDIR)/$(APPLICATION)-$(VSN).pdf - -SPECS_FILES = $(XML_REF3_FILES:%.xml=$(SPECDIR)/specs_%.xml) - TOP_SPECS_FILE = specs.xml # ---------------------------------------------------- -# FLAGS -# ---------------------------------------------------- -XML_FLAGS += -DVIPS_FLAGS += -SPECS_FLAGS = -I../../include -I../../../snmp/include \ - -I../../../kernel/include - -# ---------------------------------------------------- -# Targets -# ---------------------------------------------------- - -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ - -docs: man pdf html - -$(TOP_PDF_FILE): $(XML_FILES) - -pdf: $(TOP_PDF_FILE) - -html: gifs $(HTML_REF_MAN_FILE) - -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) - -man: $(MAN6_FILES) $(MAN3_FILES) $(MAN1_FILES) - - -debug opt: - -clean clean_docs: - rm -rf $(HTMLDIR)/* - rm -rf $(XMLDIR) - rm -f $(MAN1DIR)/* - rm -f $(MAN3DIR)/* - rm -f $(MAN6DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f $(SPECDIR)/* - rm -f errs core *~ - -# ---------------------------------------------------- -# Release Target -# ---------------------------------------------------- -include $(ERL_TOP)/make/otp_release_targets.mk - - -release_docs_spec: docs - $(INSTALL_DIR) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DATA) $(TOP_PDF_FILE) "$(RELSYSDIR)/doc/pdf" - $(INSTALL_DIR) "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(HTMLDIR)/* \ - "$(RELSYSDIR)/doc/html" - $(INSTALL_DATA) $(INFO_FILE) "$(RELSYSDIR)" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man1" - $(INSTALL_DATA) $(MAN1DIR)/* "$(RELEASE_PATH)/man/man1" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" - $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" - $(INSTALL_DIR) "$(RELEASE_PATH)/man/man6" - $(INSTALL_DATA) $(MAN6DIR)/* "$(RELEASE_PATH)/man/man6" - -release_spec: -release_tests_spec: +include $(ERL_TOP)/make/doc.mk diff --git a/lib/common_test/doc/src/ct_run.xml b/lib/common_test/doc/src/ct_run_cmd.xml index 5b962ed5c7..3a9b8bbc03 100644 --- a/lib/common_test/doc/src/ct_run.xml +++ b/lib/common_test/doc/src/ct_run_cmd.xml @@ -11,7 +11,7 @@ Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software @@ -226,4 +226,3 @@ </section> </comref> - diff --git a/lib/common_test/doc/src/ref_man.xml b/lib/common_test/doc/src/ref_man.xml index 1ac20db5c2..e916fc7cec 100644 --- a/lib/common_test/doc/src/ref_man.xml +++ b/lib/common_test/doc/src/ref_man.xml @@ -33,7 +33,7 @@ </description> <xi:include href="common_test_app.xml"/> - <xi:include href="ct_run.xml"/> + <xi:include href="ct_run_cmd.xml"/> <xi:include href="ct.xml"/> <xi:include href="ct_master.xml"/> <xi:include href="ct_cover.xml"/> |