Merge branch 'hb/dialyzer/deprecate_types/OTP-10342'

* hb/dialyzer/deprecate_types/OTP-10342:
  Introduce compiler option 'nowarn_deprecated_type'
  Improve message about deprecated built-in types

5 files changed, 81 insertions, 29 deletions

diff --git a/lib/compiler/doc/src/compile.xml b/lib/compiler/doc/src/compile.xml
index c66c8ea4bf..5fccdcdcb5 100644
--- a/lib/compiler/doc/src/compile.xml
+++ b/lib/compiler/doc/src/compile.xml
@@ -4,7 +4,7 @@
 <erlref>
   <header>
     <copyright>
-      <year>1996</year><year>2013</year>
+      <year>1996</year><year>2014</year>
       <holder>Ericsson AB. All Rights Reserved.</holder>
     </copyright>
     <legalnotice>
@@ -551,6 +551,14 @@ module.beam: module.erl \
               <c>{Module,Name,Arity}</c> or a list of such tuples.</p>
           </item>
 
+	  <tag><c>nowarn_deprecated_type</c></tag>
+          <item>
+            <p>Turns off warnings for uses of deprecated types. By
+	      default (<c>warn_deprecated_type</c>), warnings are
+	      emitted for every use of a type known by the compiler
+	      to be deprecated.</p>
+          </item>
+
 	  <tag><c>warn_obsolete_guard</c></tag>
           <item>
             <p>Causes warnings to be emitted for calls to old type
diff --git a/lib/dialyzer/test/small_SUITE_data/src/predef.erl b/lib/dialyzer/test/small_SUITE_data/src/predef.erl
index c2364fd1c2..ee9073aa67 100644
--- a/lib/dialyzer/test/small_SUITE_data/src/predef.erl
+++ b/lib/dialyzer/test/small_SUITE_data/src/predef.erl
@@ -5,8 +5,8 @@
 
 -export_type([array/0, digraph/0, gb_set/0]).
 
-%% Before R17B local re-definitions of pre-defined opaque types were
-%% ignored but did not generate any warning.
+%% Before Erlang/OTP 17.0 local re-definitions of pre-defined opaque
+%% types were ignored but did not generate any warning.
 -opaque array() :: atom().
 -opaque digraph() :: atom().
 -opaque gb_set() :: atom().
diff --git a/lib/stdlib/src/erl_lint.erl b/lib/stdlib/src/erl_lint.erl
index 9f5be2da37..1fe0bd5896 100644
--- a/lib/stdlib/src/erl_lint.erl
+++ b/lib/stdlib/src/erl_lint.erl
@@ -344,10 +344,19 @@ format_error(spec_wrong_arity) ->
     "spec has the wrong arity";
 format_error(callback_wrong_arity) ->
     "callback has the wrong arity";
-format_error({deprecated_type, {Name, Arity}, {Mod, NewName}, Rel}) ->
+format_error({deprecated_builtin_type, {Name, Arity},
+              Replacement, Rel}) ->
+    UseS = case Replacement of
+               {Mod, NewName} ->
+                   io_lib:format("use ~w:~w/~w", [Mod, NewName, Arity]);
+               {Mod, NewName, NewArity} ->
+                   io_lib:format("use ~w:~w/~w or preferably ~w:~w/~w",
+                                 [Mod, NewName, Arity,
+                                  Mod, NewName, NewArity])
+           end,
     io_lib:format("type ~w/~w is deprecated and will be "
-                  "removed in ~s; use ~w:~w/~w",
-                  [Name, Arity, Rel, Mod, NewName, Arity]);
+                  "removed in ~s; use ~s",
+                  [Name, Arity, Rel, UseS]);
 format_error({not_exported_opaque, {TypeName, Arity}}) ->
     io_lib:format("opaque type ~w~s is not exported",
                   [TypeName, gen_type_paren(Arity)]);
@@ -499,6 +508,9 @@ start(File, Opts) ->
 	 {deprecated_function,
 	  bool_option(warn_deprecated_function, nowarn_deprecated_function,
 		      true, Opts)},
+	 {deprecated_type,
+	  bool_option(warn_deprecated_type, nowarn_deprecated_type,
+		      true, Opts)},
          {obsolete_guard,
           bool_option(warn_obsolete_guard, nowarn_obsolete_guard,
                       true, Opts)},
@@ -2637,10 +2649,11 @@ check_type({type, La, TypeName, Args}, SeenVars, St) ->
     St1 = case is_var_arity_type(TypeName) of
 	      true -> St;
 	      false ->
-                  Obsolete = obsolete_type(TypePair),
+                  Obsolete = (is_warn_enabled(deprecated_type, St)
+                              andalso obsolete_builtin_type(TypePair)),
                   IsObsolete =
                       case Obsolete of
-                          {deprecated, {M, _}, _} when M =/= Module ->
+                          {deprecated, Repl, _} when element(1, Repl) =/= Module ->
                               case dict:find(TypePair, Types) of
                                   {ok, _} -> false;
                                   error -> true
@@ -2650,7 +2663,8 @@ check_type({type, La, TypeName, Args}, SeenVars, St) ->
                   case IsObsolete of
                       true ->
                           {deprecated, Replacement, Rel} = Obsolete,
-                          W = {deprecated_type, TypePair, Replacement, Rel},
+                          Tag = deprecated_builtin_type,
+                          W = {Tag, TypePair, Replacement, Rel},
                           add_warning(La, W, St);
                       false ->
                           OldUsed = Usage#usage.used_types,
@@ -2780,15 +2794,23 @@ is_newly_introduced_builtin_type({boolean, 0}) -> true;
 is_newly_introduced_builtin_type({Name, _}) when is_atom(Name) -> false.
 
 %% Obsolete in OTP 17.0.
-obsolete_type({array, 0}) -> {deprecated, {array, array}, "OTP 18.0"};
-obsolete_type({dict, 0}) -> {deprecated, {dict, dict}, "OTP 18.0"};
-obsolete_type({digraph, 0}) -> {deprecated, {digraph, graph}, "OTP 18.0"};
-obsolete_type({gb_set, 0}) -> {deprecated, {gb_sets, set}, "OTP 18.0"};
-obsolete_type({gb_tree, 0}) -> {deprecated, {gb_trees, tree}, "OTP 18.0"};
-obsolete_type({queue, 0}) -> {deprecated, {queue, queue}, "OTP 18.0"};
-obsolete_type({set, 0}) -> {deprecated, {sets, set}, "OTP 18.0"};
-obsolete_type({tid, 0}) -> {deprecated, {ets, tid}, "OTP 18.0"};
-obsolete_type({Name, _}) when is_atom(Name) -> no.
+obsolete_builtin_type({array, 0}) ->
+    {deprecated, {array, array, 1}, "OTP 18.0"};
+obsolete_builtin_type({dict, 0}) ->
+    {deprecated, {dict, dict, 2}, "OTP 18.0"};
+obsolete_builtin_type({digraph, 0}) ->
+    {deprecated, {digraph, graph}, "OTP 18.0"};
+obsolete_builtin_type({gb_set, 0}) ->
+    {deprecated, {gb_sets, set, 1}, "OTP 18.0"};
+obsolete_builtin_type({gb_tree, 0}) ->
+    {deprecated, {gb_trees, tree, 2}, "OTP 18.0"};
+obsolete_builtin_type({queue, 0}) ->
+    {deprecated, {queue, queue, 1}, "OTP 18.0"};
+obsolete_builtin_type({set, 0}) ->
+    {deprecated, {sets, set, 1}, "OTP 18.0"};
+obsolete_builtin_type({tid, 0}) ->
+    {deprecated, {ets, tid}, "OTP 18.0"};
+obsolete_builtin_type({Name, _}) when is_atom(Name) -> no.
 
 %% spec_decl(Line, Fun, Types, State) -> State.
 
diff --git a/lib/stdlib/test/erl_lint_SUITE.erl b/lib/stdlib/test/erl_lint_SUITE.erl
index 1614a2722f..8754677466 100644
--- a/lib/stdlib/test/erl_lint_SUITE.erl
+++ b/lib/stdlib/test/erl_lint_SUITE.erl
@@ -3243,20 +3243,42 @@ bin_syntax_errors(Config) ->
     ok.
 
 predef(doc) ->
-    "Predefined types: array(), digraph(), and so on";
+    "OTP-10342: Predefined types: array(), digraph(), and so on";
 predef(suite) -> [];
 predef(Config) when is_list(Config) ->
     W = get_compilation_warnings(Config, "predef", []),
     [] = W,
     W2 = get_compilation_warnings(Config, "predef2", []),
-    [{7,erl_lint,{deprecated_type,{array,0},{array,array},"OTP 18.0"}},
-     {12,erl_lint,{deprecated_type,{dict,0},{dict,dict},"OTP 18.0"}},
-     {17,erl_lint,{deprecated_type,{digraph,0},{digraph,graph},"OTP 18.0"}},
-     {27,erl_lint,{deprecated_type,{gb_set,0},{gb_sets,set},"OTP 18.0"}},
-     {32,erl_lint,{deprecated_type,{gb_tree,0},{gb_trees,tree},"OTP 18.0"}},
-     {37,erl_lint,{deprecated_type,{queue,0},{queue,queue},"OTP 18.0"}},
-     {42,erl_lint,{deprecated_type,{set,0},{sets,set},"OTP 18.0"}},
-     {47,erl_lint,{deprecated_type,{tid,0},{ets,tid},"OTP 18.0"}}] = W2,
+    Tag = deprecated_builtin_type,
+    [{7,erl_lint,{Tag,{array,0},{array,array,1},"OTP 18.0"}},
+     {12,erl_lint,{Tag,{dict,0},{dict,dict,2},"OTP 18.0"}},
+     {17,erl_lint,{Tag,{digraph,0},{digraph,graph},"OTP 18.0"}},
+     {27,erl_lint,{Tag,{gb_set,0},{gb_sets,set,1},"OTP 18.0"}},
+     {32,erl_lint,{Tag,{gb_tree,0},{gb_trees,tree,2},"OTP 18.0"}},
+     {37,erl_lint,{Tag,{queue,0},{queue,queue,1},"OTP 18.0"}},
+     {42,erl_lint,{Tag,{set,0},{sets,set,1},"OTP 18.0"}},
+     {47,erl_lint,{Tag,{tid,0},{ets,tid},"OTP 18.0"}}] = W2,
+    Ts = [{otp_10342_1,
+           <<"-compile(nowarn_deprecated_type).
+
+              -spec t(dict()) -> non_neg_integer().
+
+              t(D) ->
+                  erlang:phash2(D, 3000).
+             ">>,
+           {[nowarn_unused_function]},
+           []},
+         {otp_10342_2,
+           <<"-spec t(dict()) -> non_neg_integer().
+
+              t(D) ->
+                  erlang:phash2(D, 3000).
+             ">>,
+           {[nowarn_unused_function]},
+           {warnings,[{1,erl_lint,
+                       {deprecated_builtin_type,{dict,0},{dict,dict,2},
+                        "OTP 18.0"}}]}}],
+    [] = run(Config, Ts),
     ok.
 
 run(Config, Tests) ->
diff --git a/lib/stdlib/test/erl_lint_SUITE_data/predef.erl b/lib/stdlib/test/erl_lint_SUITE_data/predef.erl
index c2364fd1c2..ee9073aa67 100644
--- a/lib/stdlib/test/erl_lint_SUITE_data/predef.erl
+++ b/lib/stdlib/test/erl_lint_SUITE_data/predef.erl
@@ -5,8 +5,8 @@
 
 -export_type([array/0, digraph/0, gb_set/0]).
 
-%% Before R17B local re-definitions of pre-defined opaque types were
-%% ignored but did not generate any warning.
+%% Before Erlang/OTP 17.0 local re-definitions of pre-defined opaque
+%% types were ignored but did not generate any warning.
 -opaque array() :: atom().
 -opaque digraph() :: atom().
 -opaque gb_set() :: atom().