Add a proplist() type

Recently I was adding specs to an API and found that there is
no canonical proplist() type defined.

6 files changed, 11 insertions, 17 deletions

diff --git a/lib/common_test/src/ct_hooks.erl b/lib/common_test/src/ct_hooks.erl
index 984e04b90f..ece592e320 100644
--- a/lib/common_test/src/ct_hooks.erl
+++ b/lib/common_test/src/ct_hooks.erl
@@ -31,8 +31,6 @@
 -export([on_tc_skip/2]).
 -export([on_tc_fail/2]).
 
--type proplist() :: [{atom(),term()}].
-
 %% If you change this, remember to update ct_util:look -> stop clause as well.
 -define(config_name, ct_hooks).
 
@@ -59,7 +57,7 @@ terminate(Hooks) ->
 %% @doc Called as each test case is started. This includes all configuration
 %% tests.
 -spec init_tc(Mod :: atom(), Func :: atom(), Args :: list()) ->
-    NewConfig :: proplist() |
+    NewConfig :: proplists:proplist() |
     {skip, Reason :: term()} |
     {auto_skip, Reason :: term()} |
     {fail, Reason :: term()}.
@@ -92,7 +90,7 @@ init_tc(_Mod, TC, Config) ->
 	     Args :: list(),
 	     Result :: term(),
 	     Resturn :: term()) ->
-    NewConfig :: proplist() |
+    NewConfig :: proplists:proplist() |
     {skip, Reason :: term()} |
     {auto_skip, Reason :: term()} |
     {fail, Reason :: term()} |
diff --git a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
index ebebfd18a9..71ed61b4c0 100644
--- a/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
+++ b/lib/common_test/test/ct_hooks_SUITE_data/cth/tests/empty_cth.erl
@@ -59,8 +59,7 @@
 -include_lib("common_test/src/ct_util.hrl").

 -include_lib("common_test/include/ct_event.hrl").

 

--type proplist() :: list({atom(),term()}).

--type config() :: proplist().

+-type config() :: proplists:proplist().
 -type reason() :: term().

 -type skip_or_fail() :: {skip, reason()} |

                         {auto_skip, reason()} |

@@ -71,7 +70,7 @@
 

 %% @doc Always called before any other callback function. Use this to initiate

 %% any common state. It should return an state for this CTH.

--spec init(Id :: term(), Opts :: proplist()) ->

+-spec init(Id :: term(), Opts :: proplists:proplist()) ->
     State :: #state{}.

 init(Id, Opts) ->

     gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(),

@@ -81,7 +80,7 @@ init(Id, Opts) ->
 %% @doc The ID is used to uniquly identify an CTH instance, if two CTH's 

 %% return the same ID the seconds CTH is ignored. This function should NOT 

 %% have any side effects as it might be called multiple times by common test.

--spec id(Opts :: proplist()) ->

+-spec id(Opts :: proplists:proplist()) ->
     Id :: term().

 id(Opts) ->

     gen_event:notify(?CT_EVMGR_REF, #event{ name = cth, node = node(),

diff --git a/lib/dialyzer/test/small_SUITE_data/src/file_open_encoding.erl b/lib/dialyzer/test/small_SUITE_data/src/file_open_encoding.erl
index 4f1268eba8..086df3464b 100644
--- a/lib/dialyzer/test/small_SUITE_data/src/file_open_encoding.erl
+++ b/lib/dialyzer/test/small_SUITE_data/src/file_open_encoding.erl
@@ -6,9 +6,7 @@
 
 -export([parse/1]).
 
--type proplist() :: [{atom(), any()}].
-
--spec parse(string()) -> proplist().
+-spec parse(string()) -> proplists:proplist().
 parse(FileName) ->
   {ok, IoDevice} = file:open(FileName, [read, binary, {encoding, utf8}]),
   do_parse(IoDevice, []).
diff --git a/lib/edoc/src/edoc_specs.erl b/lib/edoc/src/edoc_specs.erl
index 519ade726f..b3d2da5a86 100644
--- a/lib/edoc/src/edoc_specs.erl
+++ b/lib/edoc/src/edoc_specs.erl
@@ -27,7 +27,6 @@
 -include("edoc.hrl").
 -include("edoc_types.hrl").
 
--type proplist() :: [proplists:property()].
 -type syntaxTree() :: erl_syntax:syntaxTree().
 
 -define(TOP_TYPE, term).
@@ -98,7 +97,7 @@ docs(Forms, CommentFun) ->
 -type entry() :: #entry{}.
 -type module_info() :: #module{}.
 -type entries() :: [entry()].
--spec add_data(Entries::entries(), Options::proplist(),
+-spec add_data(Entries::entries(), Options::proplists:proplist(),
                File::file:filename(), Module::module_info()) -> entries().
 
 %% @doc Create tags a la EDoc for Erlang specifications and types.
diff --git a/lib/stdlib/src/proplists.erl b/lib/stdlib/src/proplists.erl
index 68697d0da2..e3eda5d932 100644
--- a/lib/stdlib/src/proplists.erl
+++ b/lib/stdlib/src/proplists.erl
@@ -49,9 +49,10 @@
 
 %% ---------------------------------------------------------------------
 
--export_type([property/0]).
+-export_type([property/0, proplist/0]).
 
 -type property()   :: atom() | tuple().
+-type proplist()  :: [property()].
 
 %% ---------------------------------------------------------------------
 
diff --git a/lib/test_server/src/ts_install_cth.erl b/lib/test_server/src/ts_install_cth.erl
index c5444a342f..0770190c36 100644
--- a/lib/test_server/src/ts_install_cth.erl
+++ b/lib/test_server/src/ts_install_cth.erl
@@ -49,8 +49,7 @@
 
 -include_lib("kernel/include/file.hrl").
 
--type proplist() :: list({atom(),term()}).
--type config() :: proplist().
+-type config() :: proplists:proplist().
 -type reason() :: term().
 -type skip_or_fail() :: {skip, reason()} |
                         {auto_skip, reason()} |
@@ -65,7 +64,7 @@ id(_Opts) ->
     ?MODULE.
 
 %% @doc Always called before any other callback function.
--spec init(Id :: term(), Opts :: proplist()) ->
+-spec init(Id :: term(), Opts :: proplists:proplist()) ->
     State :: #state{}.
 init(_Id, Opts) ->
     Nodenames = proplists:get_value(nodenames, Opts, 0),