Permalink
Browse files

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).
  • Loading branch information...
1 parent 924f3aa commit 7aa2cb2e64cd404f8a9f388d85ab287ced95f139 @rickard-green rickard-green committed with Erlang/OTP Feb 16, 2010
Showing with 1,595 additions and 1,345 deletions.
  1. +1 −0 INSTALL-CROSS.md
  2. +779 −0 INSTALL-WIN32.md
  3. +661 −0 INSTALL.md
  4. +47 −8 Makefile.in
  5. +0 −562 README
  6. +76 −0 README.md
  7. +0 −763 README.win32
  8. +4 −2 TAR.include
  9. +6 −6 system/doc/installation_guide/Makefile
  10. +20 −3 system/doc/installation_guide/install.xml
  11. +1 −1 xcomp/README.md
View
View
Oops, something went wrong.
View
Oops, something went wrong.
View
@@ -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 "<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01 Transitional//EN\">" > $@
+ echo "<html xmlns:fn=\"http://www.w3.org/2005/02/xpath-functions\"><head>" >> $@
+ echo "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\">" >> $@
+ echo "<style type=\"text/css\">" >> $@
+ echo "body {" >> $@
+ echo " margin: 4em 4em 4em 4em;" >> $@
+ echo " background: white;" >> $@
+ echo " font-family: Verdana, Arial, Helvetica, sans-serif;" >> $@
+ echo "}" >> $@
+ echo "code { font-family: courier;font-weight: normal}" >> $@
+ echo "a:link { color: blue; text-decoration: none }" >> $@
+ echo "a:active { color: blue; text-decoration: none }" >> $@
+ echo "a:visited { color: blue; text-decoration: none }" >> $@
+ echo "</style><title>" >> $@
+ cat $< | sed -n "s/[ ]*\([^ ].*[^ ]\)[ ]*/\1/p;/[ ]*[^ ][ ]*/q" >> $@
+ echo "</title></head><body>" >> $@
+ifneq ($(MD2HTML),)
+ $(MD2HTML) $< >> $@
+else
+ echo "<pre>" >> $@
+ cat $< | sed "s|\&|\&amp\;|g;s|\"|\&quot\;|g;s|<|\&lt\;|g;s|>|\&gt\;|g" >> $@
+ echo "</pre>" >> $@
+endif
+ echo "</body></html>" >> $@
# ----------------------------------------------------------------------
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
Oops, something went wrong.

0 comments on commit 7aa2cb2

Please sign in to comment.