diff options
author | Lukas Larsson <lukas@erlang.org> | 2020-02-24 13:38:53 +0100 |
---|---|---|
committer | Lukas Larsson <lukas@erlang.org> | 2020-02-24 13:38:53 +0100 |
commit | dd3b0157d2b20adacd98fea64b3af443b6639b9a (patch) | |
tree | 8b2a1bd6678d159e287dcf0a38c3dd58a1526f29 /lib/tools | |
parent | 912db3529b2485261baf38f5a5855acf4a147fbb (diff) | |
parent | 1befa3c8ea9c1ddab1da4c5f94b5c64dc240dacd (diff) | |
download | erlang-dd3b0157d2b20adacd98fea64b3af443b6639b9a.tar.gz |
Merge branch 'lukas/kernel/code-chunk-lookup/OTP-16494/OTP-16222/OTP-16406/OTP-16499/OTP-16500/OTP-16501/OTP-16502/OTP-16503'
* lukas/kernel/code-chunk-lookup/OTP-16494/OTP-16222/OTP-16406/OTP-16499/OTP-16500/OTP-16501/OTP-16502/OTP-16503: (27 commits)
otp: Update doc build instructions with DOC_TARGETS
Include erts in travis dialyzer run
erts: Fix unmatched return dialyzer warning
Move chunk into erlang module for speed
Update primary bootstrap
Add DOC_TARGETS makefile variable
Start work on documentation for EEP-48
Remove term_to_binary of doc chunks doc content
Use <code> for monospace, remove anno, add <a marker>
Insert newline before paragraph if the previous element did not
Generate hidden chunk files for any internal modules
Implement EEP-48 aka doc chunks
doc: Move typer cli app to REF1 section
otp: Refactor doc make system and introduce EEP-48
Fix docs to handle chunk generation
Fix mnesia docs to use common name convention
Fix ssh type doc to use common name convention
Fix ssl doc to use a single name convention
Add Module prefix to all callbacks
docgen: Remove many dead entities from dtds
...
Diffstat (limited to 'lib/tools')
-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 | ||||
-rw-r--r-- | lib/tools/emacs/Makefile | 16 | ||||
-rw-r--r-- | lib/tools/src/eprof.erl | 2 |
5 files changed, 13 insertions, 86 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 diff --git a/lib/tools/emacs/Makefile b/lib/tools/emacs/Makefile index b7775d1c8c..c19ad3668c 100644 --- a/lib/tools/emacs/Makefile +++ b/lib/tools/emacs/Makefile @@ -65,7 +65,9 @@ clean: rm -f $(TARGET_FILES) $(ELC_FILES) rm -f errs core *~ -docs: +DOC_TARGETS?=man + +docs: $(DOC_TARGETS) # ---------------------------------------------------- # Release Target @@ -77,14 +79,8 @@ release_spec: opt $(INSTALL_DATA) $(EL_FILES) $(README_FILES) \ "$(RELSYSDIR)/emacs" -ifeq ($(DOCTYPE),pdf) -release_docs_spec: -else -ifeq ($(DOCTYPE),ps) -release_docs_spec: -else -release_docs_spec: docs +release_man_spec: $(INSTALL_DIR) "$(RELEASE_PATH)/man/man3" $(INSTALL_DATA) $(MAN_FILES) "$(RELEASE_PATH)/man/man3" -endif -endif + +release_docs_spec: $(DOC_TARGETS:%=release_%_spec) diff --git a/lib/tools/src/eprof.erl b/lib/tools/src/eprof.erl index 86e3d3a8b8..ee72bad234 100644 --- a/lib/tools/src/eprof.erl +++ b/lib/tools/src/eprof.erl @@ -28,7 +28,7 @@ stop/0, dump/0, dump_data/0, start_profiling/1, start_profiling/2, start_profiling/3, - profile/1, profile/2, profile/3, profile/4, profile/5, + profile/1, profile/2, profile/3, profile/4, profile/5, profile/6, stop_profiling/0, analyze/0, analyze/1, analyze/2, analyze/4, log/1]). |