diff options
Diffstat (limited to 'lib/tools/doc')
-rw-r--r-- | lib/tools/doc/src/Makefile | 77 | ||||
-rw-r--r-- | lib/tools/doc/src/cprof.xml | 2 | ||||
-rw-r--r-- | lib/tools/doc/src/xref.xml | 2 |
3 files changed, 6 insertions, 75 deletions
diff --git a/lib/tools/doc/src/Makefile b/lib/tools/doc/src/Makefile index 5ff4fe3113..f9bb2314a8 100644 --- a/lib/tools/doc/src/Makefile +++ b/lib/tools/doc/src/Makefile @@ -28,11 +28,6 @@ VSN=$(TOOLS_VSN) APPLICATION=tools # ---------------------------------------------------- -# Release directory specification -# ---------------------------------------------------- -RELSYSDIR = $(RELEASE_PATH)/lib/$(APPLICATION)-$(VSN) - -# ---------------------------------------------------- # Target Specs # ---------------------------------------------------- XML_APPLICATION_FILES = ref_man.xml @@ -60,89 +55,25 @@ XML_CHAPTER_FILES = \ xref_chapter.xml \ notes.xml - BOOK_FILES = book.xml XML_FILES = \ $(BOOK_FILES) $(XML_CHAPTER_FILES) \ $(XML_PART_FILES) $(XML_REF3_FILES) $(XML_APPLICATION_FILES) -GIF_FILES = \ +IMAGE_FILES = \ venn1.gif \ venn2.gif -# ---------------------------------------------------- - -HTML_FILES = $(XML_APPLICATION_FILES:%.xml=$(HTMLDIR)/%.html) \ - $(XML_PART_FILES:%.xml=$(HTMLDIR)/%.html) - -INFO_FILE = ../../info - -MAN3_FILES = $(XML_REF3_FILES:%.xml=$(MAN3DIR)/%.3) - -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 += - -TOOLS_SRC=$(ERL_TOP)/lib/tools/src -TOOLS_INCLUDE=$(ERL_TOP)/lib/tools/include - -SPECS_FLAGS = -I$(TOOLS_SRC) -I$(TOOLS_INCLUDE) +NO_CHUNKS = erlang_mode.xml # ---------------------------------------------------- -# Targets -# ---------------------------------------------------- -$(HTMLDIR)/%.gif: %.gif - $(INSTALL_DATA) $< $@ - -docs: pdf html man - -$(TOP_PDF_FILE): $(XML_FILES) - -pdf: $(TOP_PDF_FILE) - -html: gifs $(HTML_REF_MAN_FILE) - -man: $(MAN3_FILES) - -gifs: $(GIF_FILES:%=$(HTMLDIR)/%) - -debug opt: - -clean clean_docs: - rm -rf $(HTMLDIR)/* - rm -rf $(XMLDIR) - rm -f $(MAN3DIR)/* - rm -f $(TOP_PDF_FILE) $(TOP_PDF_FILE:%.pdf=%.fo) - rm -f $(SPECDIR)/* - rm -f errs core *~ # erlang_mode doesn't have erlang source so we generate a dummy file for it. $(SPECDIR)/specs_erlang_mode.xml: - echo '<module name="erlang_mode"/>' > $(SPECDIR)/specs_erlang_mode.xml + $(gen_verbose)echo '<module name="erlang_mode"/>' > $(SPECDIR)/specs_erlang_mode.xml # ---------------------------------------------------- -# 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/man3" - $(INSTALL_DATA) $(MAN3DIR)/* "$(RELEASE_PATH)/man/man3" - -release_spec: +include $(ERL_TOP)/make/doc.mk diff --git a/lib/tools/doc/src/cprof.xml b/lib/tools/doc/src/cprof.xml index b6af8b6d28..791fb06ba1 100644 --- a/lib/tools/doc/src/cprof.xml +++ b/lib/tools/doc/src/cprof.xml @@ -44,7 +44,7 @@ </p> <p>Since breakpoints are used there is no need for special compilation of any module to be profiled. For now these - breakpoints can only be set on BEAM code so <term id="BIF"></term>s + breakpoints can only be set on BEAM code so BIFs cannot be call count traced. </p> <p>The size of the call counters is the host machine word diff --git a/lib/tools/doc/src/xref.xml b/lib/tools/doc/src/xref.xml index 25ae9b6159..91f152e678 100644 --- a/lib/tools/doc/src/xref.xml +++ b/lib/tools/doc/src/xref.xml @@ -46,7 +46,7 @@ <em>Module data</em>, which are extracted from BEAM files, include local functions, exported functions, local calls and external calls. By default, - calls to built-in functions (<term id="BIF"></term>) are ignored, but + calls to built-in functions (BIF) are ignored, but if the option <c>builtins</c>, accepted by some of this module's functions, is set to <c>true</c>, calls to BIFs are included as well. It is the analyzing OTP version that |