Merge branch 'lars/documentation-build-git/OTP-8601' into dev

* lars/documentation-build-git/OTP-8601:
  Fixed that the system documentation can be built from both a source and release structure.

3 files changed, 123 insertions, 72 deletions

diff --git a/system/doc/top/Makefile b/system/doc/top/Makefile
index 154deb006b..148fefaf13 100644
--- a/system/doc/top/Makefile
+++ b/system/doc/top/Makefile
@@ -111,6 +111,10 @@ GLOSSARY  = $(HTMLDIR)/glossary.html
 GLOSSARY_SRC = $(ERL_TOP)/system/internal_tools/doctools/src/glossary.erl
 GLOSSARY_SCRIPT = $(EBIN)/glossary.$(EMULATOR)
 
+TEMPLATES = \
+	templates/index.html.src \
+	templates/applications.html.src
+
 #--------------------------------------------------------------------------
 
 $(INDEX_SCRIPT): $(INDEX_SRC)
@@ -119,8 +123,14 @@ $(INDEX_SCRIPT): $(INDEX_SRC)
 # We don't list toc_*.html as targets because we don't know
 $(HTMLDIR)/index.html + $(HTMLDIR)/applications.html: $(INDEX_SCRIPT)
 	echo "Generating index $@"
-	$(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index $(ERL_TOP) \
-	$(HTMLDIR) $(SYSTEM_VSN) -s erlang halt
+# Check if we are building the index from source or an installed release
+	if test "$$RELEASE_ROOT" = "" ; then \
+		$(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index src $(ERL_TOP) \
+		$(HTMLDIR) $(SYSTEM_VSN) -s erlang halt ;\
+	else \
+		$(ERL) -noshell -pa $(EBIN) -s erl_html_tools top_index rel $(RELEASE_ROOT) \
+		$(HTMLDIR) $(SYSTEM_VSN) -s erlang halt ;\
+	fi
 
 
 #--------------------------------------------------------------------------
@@ -139,8 +149,15 @@ $(MAN_INDEX_SCRIPT): $(MAN_INDEX_SRC)
 	$(ERLC) -o$(EBIN) +warn_unused_vars $<
 
 $(MAN_INDEX): $(MAN_INDEX_SCRIPT)
-	$(ERL) -noshell -pa $(EBIN) -s otp_man_index gen $(ERL_TOP) $@  \
-		-s erlang halt
+# Check if we are building the index from source or an installed release
+	if test "$$RELEASE_ROOT" = "" ; then \
+		$(ERL) -noshell -pa $(EBIN) -s otp_man_index gen src $(ERL_TOP) $@  \
+			-s erlang halt ;\
+	else \
+		$(ERL) -noshell -pa $(EBIN) -s otp_man_index gen rel $(RELEASE_ROOT) $@  \
+			-s erlang halt ;\
+	fi
+
 
 #--------------------------------------------------------------------------
 
@@ -226,7 +243,11 @@ release_docs_spec: docs
 	$(INSTALL_DIR)  $(RELSYSDIR)/js
 	$(INSTALL_DATA)  \
 		$(JAVASCRIPT) $(RELSYSDIR)/js
-	$(INSTALL_DATA) $(INDEX_FILES) $(MAN_INDEX) $(TOP_HTML_FILES) $(RELSYSDIR) 
+	$(INSTALL_DATA) $(INDEX_FILES) $(MAN_INDEX) $(TOP_HTML_FILES) $(RELSYSDIR)
+	$(INSTALL_DIR)  $(RELSYSDIR)/docbuild
+	$(INSTALL_DATA) $(INDEX_SCRIPT) $(MAN_INDEX_SCRIPT) $(JAVASCRIPT_BUILD_SCRIPT) \
+		$(INDEX_SCRIPT_SRC) $(MAN_INDEX_SCRIPT_SRC) $(JAVASCRIPT_BUILD_SCRIPT_SRC) \
+		$(TEMPLATES) $(RELSYSDIR)/docbuild
 
 
 release_spec:
diff --git a/system/doc/top/src/erl_html_tools.erl b/system/doc/top/src/erl_html_tools.erl
index c920245f94..fef56331fc 100644
--- a/system/doc/top/src/erl_html_tools.erl
+++ b/system/doc/top/src/erl_html_tools.erl
@@ -26,7 +26,7 @@
 %%-----------------------------------------------------------------
 -module(erl_html_tools). 
 
--export([top_index/0,top_index/1,top_index/3,top_index_silent/3]).
+-export([top_index/0,top_index/1,top_index/4,top_index_silent/3]).
 
 -include_lib("kernel/include/file.hrl").
 
@@ -49,19 +49,22 @@ top_index() ->
 	    io:format("Variable ERL_TOP is required\n",[]);
 	Value ->
 	    {_,RelName} = init:script_id(),	    
-	    top_index(Value, filename:join(Value, "doc"), RelName)
+	    top_index(src, Value, filename:join(Value, "doc"), RelName)
     end.
 
-top_index([RootDir, DestDir, OtpRel])
+top_index([src, RootDir, DestDir, OtpRel])
   when is_atom(RootDir), is_atom(DestDir), is_atom(OtpRel) ->
-    top_index(atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel));
-top_index(RootDir)  when is_atom(RootDir) ->
+    top_index(src, atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel));
+top_index([rel, RootDir, DestDir, OtpRel])
+  when is_atom(RootDir), is_atom(DestDir), is_atom(OtpRel) ->
+    top_index(rel, atom_to_list(RootDir), atom_to_list(DestDir), atom_to_list(OtpRel));
+top_index(RootDir)  when is_atom(RootDir) -> 
     {_,RelName} = init:script_id(),
-    top_index(RootDir, filename:join(RootDir, "doc"), RelName).
+    top_index(rel, RootDir, filename:join(RootDir, "doc"), RelName).
 
 
 
-top_index(RootDir, DestDir, OtpRel) ->
+top_index(Source, RootDir, DestDir, OtpRel) ->
     report("****\nRootDir: ~p", [RootDir]),
     report("****\nDestDir: ~p", [DestDir]),
     report("****\nOtpRel: ~p", [OtpRel]),
@@ -72,13 +75,13 @@ top_index(RootDir, DestDir, OtpRel) ->
     report("****\nTemplates: ~p", [Templates]),
     Bases = [{"../lib/", filename:join(RootDir,"lib")},
 	     {"../",     RootDir}],
-    Groups = find_information(Bases),
+    Groups = find_information(Source, Bases),
     report("****\nGroups: ~p", [Groups]),
     process_templates(Templates, DestDir, Groups).
 
 top_index_silent(RootDir, DestDir, OtpRel) ->
     put(silent,true),
-    Result = top_index(RootDir, DestDir, OtpRel),
+    Result = top_index(rel, RootDir, DestDir, OtpRel),
     erase(silent),
     Result.
 
@@ -159,8 +162,8 @@ find_templates([], AllSearchPaths) ->
 % This function read all application names and if present all "info" files.
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
-find_information(Bases) ->
-    Paths = find_application_paths(Bases),
+find_information(Source, Bases) ->
+    Paths = find_application_paths(Source, Bases),
 %    report("****\nPaths: ~p", [Paths]),
     Apps = find_application_infos(Paths),
 %    report("****\nApps: ~p", [Apps]),
@@ -176,35 +179,47 @@ find_information(Bases) ->
 %
 % We know URL ends in a slash.
 
-find_application_paths([]) ->
+find_application_paths(_, []) ->
     [];
-find_application_paths([{URL, Dir} | Paths]) ->
+find_application_paths(Source, [{URL, Dir} | Paths]) ->
+
+    AppDirs = get_app_dirs(Dir),   
+    AppPaths = get_app_paths(Source, AppDirs, URL),
+    AppPaths ++ find_application_paths(Source, Paths).
+
+
+get_app_paths(src, AppDirs, URL) ->
     Sub1 = "doc/html/index.html",
 %%     Sub2 = "doc/index.html",
+    lists:map(
+      fun({App, AppPath}) -> 
+	      VsnFile = filename:join(AppPath, "vsn.mk"),
+	      VsnStr = 
+		  case file:read_file(VsnFile) of
+		      {ok, Bin} ->
+			  case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of
+			      {match, [V]} ->
+				  V;
+			      nomatch ->
+				  exit(io_lib:format("No VSN variable found in ~s\n",
+						     [VsnFile]))
+			  end;
+		      {error, Reason} ->
+			  exit(io_lib:format("~p : ~s\n", [Reason, VsnFile]))
+		  end,
+	      AppURL = URL ++ App ++ "-" ++ VsnStr,
+	      {App, VsnStr, AppPath, AppURL ++ "/" ++ Sub1}
+      end, AppDirs);
+get_app_paths(rel, AppDirs, URL) ->
+    Sub1 = "doc/html/index.html",
+%%     Sub2 = "doc/index.html",
+    lists:map(
+      fun({App, AppPath}) -> 
+	      [AppName, VsnStr] = string:tokens(App, "-"),
+	      AppURL = URL ++ App,
+	      {AppName, VsnStr, AppPath, AppURL ++ "/" ++ Sub1}
+      end, AppDirs).
 
-    AppDirs = get_app_dirs(Dir),
-    
-    AppPaths =
-	lists:map(
-	  fun({App, AppPath}) -> 
-		  VsnFile = filename:join(AppPath, "vsn.mk"),
-		  VsnStr = 
-		      case file:read_file(VsnFile) of
-			  {ok, Bin} ->
-			      case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of
-				  {match, [V]} ->
-				      V;
-				  nomatch ->
-				      exit(io_lib:format("No VSN variable found in ~s\n",
-							 [VsnFile]))
-			      end;
-			  {error, Reason} ->
-			      exit(io_lib:format("~p : ~s\n", [Reason, VsnFile]))
-		      end,
-		  AppURL = URL ++ App ++ "-" ++ VsnStr,
-		  {App, VsnStr, AppPath, AppURL ++ "/" ++ Sub1}
-	  end, AppDirs),
-    AppPaths ++ find_application_paths(Paths).
 
 get_app_dirs(Dir) ->
     {ok, Files} = file:list_dir(Dir),
@@ -212,7 +227,7 @@ get_app_dirs(Dir) ->
 	lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files),
     lists:zf(fun is_app_with_doc/1, AFiles).
 
-is_app_with_doc({"." ++ ADir, _APath}) ->
+is_app_with_doc({"." ++ _ADir, _APath}) ->
     false;
 is_app_with_doc({ADir, APath}) ->
     case file:read_file_info(filename:join([APath, "info"])) of
diff --git a/system/doc/top/src/otp_man_index.erl b/system/doc/top/src/otp_man_index.erl
index 0fdc531b37..4ad975c53d 100644
--- a/system/doc/top/src/otp_man_index.erl
+++ b/system/doc/top/src/otp_man_index.erl
@@ -27,14 +27,20 @@
 
 -module(otp_man_index). 
 
--export([gen/1]).
+-export([gen/1, gen/2]).
 -include_lib("kernel/include/file.hrl").
 
 
-gen([RootDir, OutFile])  when is_atom(RootDir),  is_atom(OutFile)->
+gen([Source, RootDir, OutFile])  when is_atom(RootDir),  is_atom(OutFile)->
+    gen(Source, RootDir, OutFile).
+
+gen(RootDir, OutFile) ->
+    gen(rel, RootDir, OutFile).
+
+gen(Source, RootDir, OutFile) ->
     Bases = [{"../lib/", filename:join(RootDir, "lib")},
 	     {"../", RootDir}],
-    Apps = find_application_paths(Bases),
+    Apps = find_application_paths(Source, Bases),
     RefPages = find_ref_files(Apps),
     gen_html(RefPages, atom_to_list(OutFile)).
     
@@ -81,43 +87,52 @@ find_ref_files([{App, Vsn, AppPath, RelPath} |Apps], Acc) ->
 	    find_ref_files(Apps, Refs2 ++ Acc)
     end.
 
-find_application_paths([]) ->
+find_application_paths(_, []) ->
     [];
-find_application_paths([{URL, Dir} | Paths]) ->
-    Sub1 = "doc/html",
+find_application_paths(Source, [{URL, Dir} | Paths]) ->
 
     AppDirs = get_app_dirs(Dir),
-    
-    AppPaths =
-	lists:map(
-	  fun({App, AppPath}) -> 
-		  VsnFile = filename:join(AppPath, "vsn.mk"),
-		  VsnStr = 
-		      case file:read_file(VsnFile) of
-			  {ok, Bin} ->
-			      case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of
-				  {match, [V]} ->
-				      V;
-				  nomatch ->
-				      exit(io_lib:format("No VSN variable found in ~s\n",
-							 [VsnFile]))
-			      end;
-			  {error, Reason} ->
-			      exit(io_lib:format("~p : ~s\n", [Reason, VsnFile]))
-		      end,
-		  AppURL = URL ++ App ++ "-" ++ VsnStr,
-		  {App, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1}
-	  end, AppDirs),
-    AppPaths ++ find_application_paths(Paths).
-    
+    AppPaths = get_app_paths(Source, AppDirs, URL),
+    AppPaths ++ find_application_paths(Source, Paths).
 
+get_app_paths(src, AppDirs, URL) ->
+    Sub1 = "doc/html",
+    lists:map(
+      fun({App, AppPath}) -> 
+	      VsnFile = filename:join(AppPath, "vsn.mk"),
+	      VsnStr = 
+		  case file:read_file(VsnFile) of
+		      {ok, Bin} ->
+			  case re:run(Bin, ".*VSN\s*=\s*([0-9\.]+).*",[{capture,[1],list}]) of
+			      {match, [V]} ->
+				  V;
+			      nomatch ->
+				  exit(io_lib:format("No VSN variable found in ~s\n",
+						     [VsnFile]))
+			  end;
+		      {error, Reason} ->
+			  exit(io_lib:format("~p : ~s\n", [Reason, VsnFile]))
+		  end,
+	      AppURL = URL ++ App ++ "-" ++ VsnStr,
+	      {App, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1}
+      end, AppDirs);
+get_app_paths(rel, AppDirs, URL) ->
+    Sub1 = "doc/html",
+    lists:map(
+      fun({App, AppPath}) -> 
+	      [AppName, VsnStr] = string:tokens(App, "-"),
+	      AppURL = URL ++ App,
+	      {AppName, VsnStr, AppPath ++ "/" ++ Sub1, AppURL ++ "/" ++ Sub1}
+      end, AppDirs).
+
+    
 get_app_dirs(Dir) ->
     {ok, Files} = file:list_dir(Dir),
     AFiles = 
 	lists:map(fun(File) -> {File, filename:join([Dir, File])} end, Files),
     lists:zf(fun is_app_with_doc/1, AFiles).
 
-is_app_with_doc({"." ++ ADir, _APath}) ->
+is_app_with_doc({"." ++ _ADir, _APath}) ->
     false;
 is_app_with_doc({ADir, APath}) ->
     case file:read_file_info(filename:join([APath, "info"])) of