Merge branch 'vladdu/edoc_remove_packages/OTP-12431'

* vladdu/edoc_remove_packages/OTP-12431:
  [edoc] remove functionality related to packages
  [edoc] add test for nested source directories

1 files changed, 60 insertions, 97 deletions

diff --git a/lib/edoc/src/edoc_lib.erl b/lib/edoc/src/edoc_lib.erl
index c46338a2e1..813fcf2476 100644
--- a/lib/edoc/src/edoc_lib.erl
+++ b/lib/edoc/src/edoc_lib.erl
@@ -29,9 +29,9 @@
 	 get_first_sentence/1, is_space/1, strip_space/1, parse_expr/2,
 	 parse_contact/2, escape_uri/1, join_uri/2, is_relative_uri/1,
 	 is_name/1, to_label/1, find_doc_dirs/0, find_sources/2,
-	 find_sources/3, find_file/3, try_subdir/2, unique/1,
-	 write_file/3, write_file/4, write_file/5, write_info_file/4,
-	 read_info_file/1, get_doc_env/1, get_doc_env/4, copy_file/2,
+	 find_file/2, try_subdir/2, unique/1,
+	 write_file/3, write_file/4, write_info_file/3,
+	 read_info_file/1, get_doc_env/1, get_doc_env/3, copy_file/2,
 	 uri_get/1, run_doclet/2, run_layout/2,
 	 simplify_path/1, timestr/1, datestr/1, read_encoding/2]).
 
@@ -266,13 +266,6 @@ is_name_1([$_ | Cs]) ->
 is_name_1([]) -> true;
 is_name_1(_) -> false.
 
-to_atom(A) when is_atom(A) -> A;
-to_atom(S) when is_list(S) -> list_to_atom(S).
-
-to_list(A) when is_atom(A) -> atom_to_list(A);
-to_list(S) when is_list(S) -> S.
-
-    
 %% @private
 unique([X | Xs]) -> [X | unique(Xs, X)];
 unique([]) -> [].
@@ -674,7 +667,7 @@ simplify_path(P) ->
 try_subdir(Dir, Subdir) ->
     D = filename:join(Dir, Subdir),
     case filelib:is_dir(D) of
-	true -> D; 
+	true -> D;
 	false -> Dir
     end.
 
@@ -686,19 +679,10 @@ try_subdir(Dir, Subdir) ->
 %% @private
 
 write_file(Text, Dir, Name) ->
-    write_file(Text, Dir, Name, '').
-
-%% @spec (Text::deep_string(), Dir::edoc:filename(),
-%%        Name::edoc:filename(), Package::atom()|string()) -> ok
-%% @doc Like {@link write_file/3}, but adds path components to the target
-%% directory corresponding to the specified package.
-%% @private
+    write_file(Text, Dir, Name, [{encoding,latin1}]).
 
-write_file(Text, Dir, Name, Package) ->
-    write_file(Text, Dir, Name, Package, [{encoding,latin1}]).
-
-write_file(Text, Dir, Name, Package, Options) ->
-    File = filename:join([Dir, to_list(Package), Name]),
+write_file(Text, Dir, Name, Options) ->
+    File = filename:join([Dir, Name]),
     ok = filelib:ensure_dir(File),
     case file:open(File, [write] ++ Options) of
 	{ok, FD} ->
@@ -711,15 +695,14 @@ write_file(Text, Dir, Name, Package, Options) ->
     end.
 
 %% @private
-write_info_file(App, Packages, Modules, Dir) ->
-    Ts = [{packages, Packages},
-	  {modules, Modules}],
+write_info_file(App, Modules, Dir) ->
+    Ts = [{modules, Modules}],
     Ts1 = if App =:= ?NO_APP -> Ts;
 	     true -> [{application, App} | Ts]
 	  end,
     S0 = [io_lib:fwrite("~p.\n", [T]) || T <- Ts1],
     S = ["%% encoding: UTF-8\n" | S0],
-    write_file(S, Dir, ?INFO_FILE, '', [{encoding,unicode}]).
+    write_file(S, Dir, ?INFO_FILE, [{encoding,unicode}]).
 
 %% @spec (Name::edoc:filename()) -> {ok, string()} | {error, Reason}
 %%
@@ -744,9 +727,8 @@ read_file(File) ->
 
 info_file_data(Ts) ->
     App = proplists:get_value(application, Ts, ?NO_APP),
-    Ps = proplists:append_values(packages, Ts),
     Ms = proplists:append_values(modules, Ts),
-    {App, Ps, Ms}.
+    {App, Ms}.
 
 %% Local file access - don't complain if file does not exist.
 
@@ -761,10 +743,10 @@ read_info_file(Dir) ->
 		{error, R} ->
 		    R1 = file:format_error(R),
 		    warning("could not read '~ts': ~ts.", [File, R1]),
-		    {?NO_APP, [], []}
-	    end;	    
+		    {?NO_APP, []}
+	    end;
 	false ->
-	    {?NO_APP, [], []}
+	    {?NO_APP, []}
     end.
 
 %% URI access
@@ -776,7 +758,7 @@ uri_get_info_file(Base) ->
 	    parse_info_file(Text, URI);
 	{error, Msg} ->
 	    warning("could not read '~ts': ~ts.", [URI, Msg]),
-	    {?NO_APP, [], []}
+	    {?NO_APP, []}
     end.
 
 parse_info_file(Text, Name) ->
@@ -785,10 +767,10 @@ parse_info_file(Text, Name) ->
 	    info_file_data(Vs);
 	{error, eof} ->
 	    warning("unexpected end of file in '~ts'.", [Name]),
-	    {?NO_APP, [], []};
+	    {?NO_APP, []};
 	{error, {_Line,Module,R}} ->
 	    warning("~ts: ~ts.", [Module:format_error(R), Name]),
-	    {?NO_APP, [], []}
+	    {?NO_APP, []}
     end.
 
 parse_terms(Text) ->
@@ -815,82 +797,67 @@ parse_terms_1([], _As, _Vs) ->
 
 
 %% ---------------------------------------------------------------------
-%% Source files and packages
-
-%% @private
-find_sources(Path, Opts) ->
-    find_sources(Path, "", Opts).
+%% Source files
 
-%% @doc See {@link edoc:run/3} for a description of the options
-%% `subpackages', `source_suffix' and `exclude_packages'.
+%% @doc See {@link edoc:run/2} for a description of the options
+%% `subpackages', `source_suffix'.
 %% @private
 
-%% NEW-OPTIONS: subpackages, source_suffix, exclude_packages
-%% DEFER-OPTIONS: edoc:run/3
+%% NEW-OPTIONS: subpackages, source_suffix
+%% DEFER-OPTIONS: edoc:run/2
 
-find_sources(Path, Pkg, Opts) ->
+find_sources(Path, Opts) ->
     Rec = proplists:get_bool(subpackages, Opts),
     Ext = proplists:get_value(source_suffix, Opts, ?DEFAULT_SOURCE_SUFFIX),
-    find_sources(Path, Pkg, Rec, Ext, Opts).
+    find_sources(Path, Rec, Ext, Opts).
 
-find_sources(Path, Pkg, Rec, Ext, Opts) ->
-    Skip = proplists:get_value(exclude_packages, Opts, []),
-    lists:flatten(find_sources_1(Path, to_atom(Pkg), Rec, Ext, Skip)).
+find_sources(Path, Rec, Ext, _Opts) ->
+    lists:flatten(find_sources_1(Path, Rec, Ext)).
 
-find_sources_1([P | Ps], Pkg, Rec, Ext, Skip) ->
-    Dir = filename:join(P, atom_to_list(Pkg)),
-    Fs1 = find_sources_1(Ps, Pkg, Rec, Ext, Skip),
+find_sources_1([P | Ps], Rec, Ext) ->
+    Dir = P,
+    Fs1 = find_sources_1(Ps, Rec, Ext),
     case filelib:is_dir(Dir) of
 	true ->
-	    [find_sources_2(Dir, Pkg, Rec, Ext, Skip) | Fs1];
+	    [find_sources_2(Dir, Rec, Ext) | Fs1];
 	false ->
 	    Fs1
     end;
-find_sources_1([], _Pkg, _Rec, _Ext, _Skip) ->
+find_sources_1([], _Rec, _Ext) ->
     [].
 
-find_sources_2(Dir, Pkg, Rec, Ext, Skip) ->
-    case lists:member(Pkg, Skip) of
-	false ->
-	    Es = list_dir(Dir, false),    % just warn if listing fails
-	    Es1 = [{Pkg, E, Dir} || E <- Es, is_source_file(E, Ext)],
-	    case Rec of
+find_sources_2(Dir, Rec, Ext) ->
+	Es = list_dir(Dir, false),    % just warn if listing fails
+	Es1 = [{E, Dir} || E <- Es, is_source_file(E, Ext)],
+	case Rec of
 		true ->
-		    [find_sources_3(Es, Dir, Pkg, Rec, Ext, Skip) | Es1];
+			[find_sources_3(Es, Dir, Rec, Ext) | Es1];
 		false ->
-		    Es1
-	    end;
-	true ->
-	    []
-    end.
+			Es1
+	end.
 
-find_sources_3(Es, Dir, Pkg, Rec, Ext, Skip) ->
+find_sources_3(Es, Dir, Rec, Ext) ->
     [find_sources_2(filename:join(Dir, E),
-		    to_atom(join(Pkg, E)), Rec, Ext, Skip)
-     || E <- Es, is_package_dir(E, Dir)].
-
-join('', E) -> E;
-join(Pkg, E) -> filename:join(Pkg, E).
+		    Rec, Ext)
+     || E <- Es, is_source_dir(E, Dir)].
 
 is_source_file(Name, Ext) ->
     (filename:extension(Name) == Ext)
 	andalso is_name(filename:rootname(Name, Ext)).
 
-is_package_dir(Name, Dir) ->
-    is_name(filename:rootname(filename:basename(Name)))
-	andalso filelib:is_dir(filename:join(Dir, Name)).
+is_source_dir(Name, Dir) ->
+    filelib:is_dir(filename:join(Dir, Name)).
 
 %% @private
-find_file([P | Ps], []=Pkg, Name) ->
-    Pkg = [],
+find_file([P | Ps], Name) ->
     File = filename:join(P, Name),
     case filelib:is_file(File) of
 	true ->
-	    File;    
+	    File;
 	false ->
-	    find_file(Ps, Pkg, Name)
-    end;    
-find_file([], [], _Name) ->
+	    find_file(Ps, Name)
+    end;
+find_file([], _Name) ->
     "".
 
 %% @private
@@ -909,7 +876,7 @@ find_doc_dirs([P0 | Ps]) ->
     File = filename:join(Dir, ?INFO_FILE),
     case filelib:is_file(File) of
 	true ->
-	    [Dir | find_doc_dirs(Ps)]; 
+	    [Dir | find_doc_dirs(Ps)];
 	false ->
 	    find_doc_dirs(Ps)
     end;
@@ -923,22 +890,21 @@ find_doc_dirs([]) ->
 %% NEW-OPTIONS: doc_path
 %% DEFER-OPTIONS: get_doc_env/4
 
-get_doc_links(App, Packages, Modules, Opts) ->
+get_doc_links(App, Modules, Opts) ->
     Path = proplists:append_values(doc_path, Opts) ++ find_doc_dirs(),
     Ds = [{P, uri_get_info_file(P)} || P <- Path],
-    Ds1 = [{"", {App, Packages, Modules}} | Ds],
+    Ds1 = [{"", {App, Modules}} | Ds],
     D = dict:new(),
-    make_links(Ds1, D, D, D).
+    make_links(Ds1, D, D).
 
-make_links([{Dir, {App, Ps, Ms}} | Ds], A, P, M) ->
+make_links([{Dir, {App, Ms}} | Ds], A, M) ->
     A1 = if App == ?NO_APP -> A;
 	    true -> add_new(App, Dir, A)
 	 end,
     F = fun (K, D) -> add_new(K, Dir, D) end,
-    P1 = lists:foldl(F, P, Ps),
     M1 = lists:foldl(F, M, Ms),
-    make_links(Ds, A1, P1, M1);
-make_links([], A, P, M) ->
+    make_links(Ds, A1, M1);
+make_links([], A,  M) ->
     F = fun (D) ->
 		fun (K) ->
 			case dict:find(K, D) of
@@ -947,7 +913,7 @@ make_links([], A, P, M) ->
 			end
 		end
 	end,
-    {F(A), F(P), F(M)}.
+    {F(A), F(M)}.
 
 add_new(K, V, D) ->
     case dict:is_key(K, D) of
@@ -962,11 +928,10 @@ add_new(K, V, D) ->
 %% @private
 
 get_doc_env(Opts) ->
-    get_doc_env([], [], [], Opts).
+    get_doc_env([], [], Opts).
 
-%% @spec (App, Packages, Modules, Options::proplist()) -> edoc_env()
+%% @spec (App, Modules, Options::proplist()) -> edoc_env()
 %%     App = [] | atom()
-%%     Packages = [atom()]
 %%     Modules = [atom()]
 %%     proplist() = [term()]
 %%
@@ -985,17 +950,15 @@ get_doc_env(Opts) ->
 %% INHERIT-OPTIONS: get_doc_links/4
 %% DEFER-OPTIONS: edoc:run/3
 
-get_doc_env(App, Packages, Modules, Opts) ->
+get_doc_env(App, Modules, Opts) ->
     Suffix = proplists:get_value(file_suffix, Opts,
 				 ?DEFAULT_FILE_SUFFIX),
     AppDefault = proplists:get_value(app_default, Opts, ?APP_DEFAULT),
     Includes = proplists:append_values(includes, Opts),
 
-    {A, P, M} = get_doc_links(App, Packages, Modules, Opts),
+    {A, M} = get_doc_links(App, Modules, Opts),
     #env{file_suffix = Suffix,
-	 package_summary = ?PACKAGE_SUMMARY ++ Suffix,
 	 apps = A,
-	 packages = P,
 	 modules = M,
 	 app_default = AppDefault,
 	 includes = Includes