From 7aa2cb2e64cd404f8a9f388d85ab287ced95f139 Mon Sep 17 00:00:00 2001 From: Rickard Green Date: Tue, 16 Feb 2010 01:24:37 +0000 Subject: OTP-8449 Documentation improvements. The most important "readme" files now use Markdown notation. HTML versions of these files are now also automatically generated and included in the HTML documentation. - Building and Installing Erlang/OTP - $ERL_TOP/INSTALL.md (previously known as $ERL_TOP/README). - Cross Compiling Erlang/OTP - $ERL_TOP/INSTALL-CROSS.md. - How to Build Erlang/OTP on Windows - $ERL_TOP/INSTALL-WIN32.md (previously known as $ERL_TOP/README.win32). --- Makefile.in | 55 +++++++++++++++++++++++++++++++++++++++++++++++-------- 1 file changed, 47 insertions(+), 8 deletions(-) (limited to 'Makefile.in') diff --git a/Makefile.in b/Makefile.in index 2dcc89144d..be49761490 100644 --- a/Makefile.in +++ b/Makefile.in @@ -392,16 +392,55 @@ endif # --------------------------------------------------------------- # Target only used when building commercial ERTS patches # --------------------------------------------------------------- -release_docs docs: +release_docs docs: html_readmes ifeq ($(OTP_SMALL_BUILD),true) - cd $(ERL_TOP)/lib && $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/lib && \ + ERL_TOP=$(ERL_TOP) $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ else - cd $(ERL_TOP)/lib && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ - cd $(ERL_TOP)/lib/dialyzer && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/lib && \ + ERL_TOP=$(ERL_TOP) $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/lib/dialyzer && \ + ERL_TOP=$(ERL_TOP) $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ endif - cd $(ERL_TOP)/erts && $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ - cd $(ERL_TOP)/system/doc && $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ - + cd $(ERL_TOP)/erts && \ + ERL_TOP=$(ERL_TOP) $(MAKE) BUILD_ALL=1 TESTROOT=$(RELEASE_ROOT) $@ + cd $(ERL_TOP)/system/doc && \ + ERL_TOP=$(ERL_TOP) $(MAKE) TESTROOT=$(RELEASE_ROOT) $@ + +.PHONY: html_readmes clean_html_readmes + +HTML_READMES = INSTALL.html INSTALL-WIN32.html INSTALL-CROSS.html + +html_readmes: $(HTML_READMES) + +clean_html_readmes: + rm -f $(HTML_READMES) + +%.html: %.md + echo "" > $@ + echo "" >> $@ + echo "" >> $@ + echo "" >> $@ + cat $< | sed -n "s/[ ]*\([^ ].*[^ ]\)[ ]*/\1/p;/[ ]*[^ ][ ]*/q" >> $@ + echo "" >> $@ +ifneq ($(MD2HTML),) + $(MD2HTML) $< >> $@ +else + echo "
" >> $@
+	cat $< | sed "s|\&|\&\;|g;s|\"|\"\;|g;s|<|\<\;|g;s|>|\>\;|g" >> $@
+	echo "
" >> $@ +endif + echo "" >> $@ # ---------------------------------------------------------------------- ERLANG_EARS=$(BOOTSTRAP_ROOT)/bootstrap/erts @@ -988,7 +1027,7 @@ $(IBIN_DIR): # Clean targets # -clean: check_recreate_primary_bootstrap +clean: check_recreate_primary_bootstrap clean_html_readmes rm -f *~ *.bak config.log config.status prebuilt.files ibin/* find . -type f -name SKIP -print | xargs $(RM) cd erts && ERL_TOP=$(ERL_TOP) $(MAKE) clean -- cgit v1.2.3