path: root/lib/stdlib/src/otp_internal.erl

%%
%% WARNING: DO NOT EDIT THIS FILE.
%%
%% This file was auto-generated from attributes in the source
%% code.
%%
%% To add a description to a deprecation or removal attribute,
%% write a string after the arity:
%%
%%    -deprecated([{foo,1,"use bar/1 instead"}]).
%%    -deprecated_type([{gadget,1,"use widget/1 instead"}]).
%%    -removed([{hello,2,"use there/2 instead"}]).
%%    -removed_type([{frobnitz,1,"use grunka/1 instead"}]).
%%
%% Descriptions cannot be given with the `f/1` shorthand, and
%% it will fall back to a generic description referring the
%% user to the documentation.
%%
%% Use `./otp_build update_deprecations` to update this file
%% after adding an attribute.
%%
-module(otp_internal).
-include("otp_internal.hrl").
%%
-dialyzer({no_match, obsolete/3}).
obsolete(auth, cookie, 0) ->
    {deprecated, "use erlang:get_cookie/0 instead"};
obsolete(auth, cookie, 1) ->
    {deprecated, "use erlang:set_cookie/2 instead"};
obsolete(auth, is_auth, 1) ->
    {deprecated, "use net_adm:ping/1 instead"};
obsolete(calendar, local_time_to_universal_time, 1) ->
    {deprecated, "use calendar:local_time_to_universal_time_dst/1 instead"};
obsolete(code, is_module_native, 1) ->
    {deprecated, "HiPE has been removed", "OTP 26"};
obsolete(code, rehash, 0) ->
    {deprecated, "the code path cache feature has been removed", "OTP 26"};
obsolete(crypto, crypto_dyn_iv_init, 3) ->
    {deprecated, "see the documentation for details", "OTP 27"};
obsolete(crypto, crypto_dyn_iv_update, 3) ->
    {deprecated, "see the documentation for details", "OTP 27"};
obsolete(crypto, rand_uniform, 2) ->
    {deprecated, "use rand:uniform/1 instead"};
obsolete(disk_log, accessible_logs, 0) ->
    {deprecated, "use disk_log:all/0 instead", "OTP 26"};
obsolete(disk_log, lclose, 1) ->
    {deprecated, "use disk_log:close/1 instead", "OTP 26"};
obsolete(disk_log, lclose, 2) ->
    {deprecated, "use disk_log:close/1 instead", "OTP 26"};
obsolete(erlang, now, 0) ->
    {deprecated, "see the \"Time and Time Correction in Erlang\" chapter of the ERTS User's Guide for more information"};
obsolete(erlang, phash, 2) ->
    {deprecated, "use erlang:phash2/2 instead"};
obsolete(ftp, start_service, 1) ->
    {deprecated, "use ftp:open/2 instead", "OTP 26"};
obsolete(ftp, stop_service, 1) ->
    {deprecated, "use ftp:close/1 instead", "OTP 26"};
obsolete(http_uri, decode, 1) ->
    {deprecated, "use uri_string:unquote function instead", "OTP 26"};
obsolete(http_uri, encode, 1) ->
    {deprecated, "use uri_string:quote function instead", "OTP 26"};
obsolete(httpd, parse_query, 1) ->
    {deprecated, "use uri_string:dissect_query/1 instead"};
obsolete(httpd_util, decode_hex, 1) ->
    {deprecated, "use uri_string:unquote function instead", "OTP 26"};
obsolete(httpd_util, encode_hex, 1) ->
    {deprecated, "use uri_string:quote function instead", "OTP 26"};
obsolete(httpd_util, flatlength, 1) ->
    {deprecated, "use erlang:iolist_size/1 instead", "OTP 26"};
obsolete(httpd_util, hexlist_to_integer, 1) ->
    {deprecated, "use erlang:list_to_integer/2 with base 16 instead", "OTP 26"};
obsolete(httpd_util, integer_to_hexlist, 1) ->
    {deprecated, "use erlang:integer_to_list/2 with base 16 instead", "OTP 26"};
obsolete(httpd_util, strip, 1) ->
    {deprecated, "use string:trim/1 instead", "OTP 26"};
obsolete(httpd_util, suffix, 1) ->
    {deprecated, "use filename:extension/1 and string:trim/2 instead", "OTP 26"};
obsolete(net, broadcast, 3) ->
    {deprecated, "use rpc:eval_everywhere/3 instead"};
obsolete(net, call, 4) ->
    {deprecated, "use rpc:call/4 instead"};
obsolete(net, cast, 4) ->
    {deprecated, "use rpc:cast/4 instead"};
obsolete(net, ping, 1) ->
    {deprecated, "use net_adm:ping/1 instead"};
obsolete(net, sleep, 1) ->
    {deprecated, "use 'receive after T -> ok end' instead"};
obsolete(queue, lait, 1) ->
    {deprecated, "use queue:liat/1 instead"};
obsolete(sys, get_debug, 3) ->
    {deprecated, "incorrectly documented and only for internal use. Can often be replaced with sys:get_log/1"};
obsolete(wxCalendarCtrl, enableYearChange, 1) ->
    {deprecated, "not available in wxWidgets-2.9 and later"};
obsolete(wxCalendarCtrl, enableYearChange, 2) ->
    {deprecated, "not available in wxWidgets-2.9 and later"};
obsolete(zlib, adler32, 2) ->
    {deprecated, "use erlang:adler32/1 instead", "OTP 27"};
obsolete(zlib, adler32, 3) ->
    {deprecated, "use erlang:adler32/2 instead", "OTP 27"};
obsolete(zlib, adler32_combine, 4) ->
    {deprecated, "use erlang:adler_combine/3 instead", "OTP 27"};
obsolete(zlib, crc32, 1) ->
    {deprecated, "use erlang:crc32/1 on the uncompressed data instead", "OTP 27"};
obsolete(zlib, crc32, 2) ->
    {deprecated, "use erlang:crc32/1 instead", "OTP 27"};
obsolete(zlib, crc32, 3) ->
    {deprecated, "use erlang:crc32/2 instead", "OTP 27"};
obsolete(zlib, crc32_combine, 4) ->
    {deprecated, "use erlang:crc32_combine/3 instead", "OTP 27"};
obsolete(zlib, getBufSize, 1) ->
    {deprecated, "this function will be removed in a future release", "OTP 27"};
obsolete(zlib, inflateChunk, 1) ->
    {deprecated, "use safeInflate/2 instead", "OTP 27"};
obsolete(zlib, inflateChunk, 2) ->
    {deprecated, "use safeInflate/2 instead", "OTP 27"};
obsolete(zlib, setBufSize, 2) ->
    {deprecated, "this function will be removed in a future release", "OTP 27"};
obsolete(core_lib, get_anno, 1) ->
    {removed, "use cerl:get_ann/1 instead"};
obsolete(core_lib, is_literal, 1) ->
    {removed, "use cerl:is_literal/1 instead"};
obsolete(core_lib, is_literal_list, 1) ->
    {removed, "use cerl:is_literal_list/1 instead"};
obsolete(core_lib, literal_value, 1) ->
    {removed, "use cerl:concrete/1 instead"};
obsolete(core_lib, set_anno, 2) ->
    {removed, "use cerl:set_ann/2 instead"};
obsolete(crypto, block_decrypt, 3) ->
    {removed, "use crypto:crypto_one_time/4 or crypto:crypto_init/3 + crypto:crypto_update/2 + crypto:crypto_final/1 instead"};
obsolete(crypto, block_decrypt, 4) ->
    {removed, "use crypto:crypto_one_time/5, crypto:crypto_one_time_aead/6,7 or crypto:crypto_(dyn_iv)?_init + crypto:crypto_(dyn_iv)?_update + crypto:crypto_final instead"};
obsolete(crypto, block_encrypt, 3) ->
    {removed, "use crypto:crypto_one_time/4 or crypto:crypto_init/3 + crypto:crypto_update/2 + crypto:crypto_final/1 instead"};
obsolete(crypto, block_encrypt, 4) ->
    {removed, "use crypto:crypto_one_time/5, crypto:crypto_one_time_aead/6,7 or crypto:crypto_(dyn_iv)?_init + crypto:crypto_(dyn_iv)?_update + crypto:crypto_final instead"};
obsolete(crypto, cmac, 3) ->
    {removed, "use crypto:mac/4 instead"};
obsolete(crypto, cmac, 4) ->
    {removed, "use crypto:macN/5 instead"};
obsolete(crypto, hmac, 3) ->
    {removed, "use crypto:mac/4 instead"};
obsolete(crypto, hmac, 4) ->
    {removed, "use crypto:macN/5 instead"};
obsolete(crypto, hmac_final, 1) ->
    {removed, "use crypto:mac_final/1 instead"};
obsolete(crypto, hmac_final_n, 2) ->
    {removed, "use crypto:mac_finalN/2 instead"};
obsolete(crypto, hmac_init, 2) ->
    {removed, "use crypto:mac_init/3 instead"};
obsolete(crypto, hmac_update, 2) ->
    {removed, "use crypto:mac_update/2 instead"};
obsolete(crypto, poly1305, 2) ->
    {removed, "use crypto:mac/3 instead"};
obsolete(crypto, stream_decrypt, 2) ->
    {removed, "use crypto:crypto_update/2 instead"};
obsolete(crypto, stream_encrypt, 2) ->
    {removed, "use crypto:crypto_update/2 instead"};
obsolete(erl_lint, modify_line, 2) ->
    {removed, "use erl_parse:map_anno/2 instead"};
obsolete(erl_parse, get_attribute, 2) ->
    {removed, "erl_anno:{column,line,location,text}/1 instead"};
obsolete(erl_parse, get_attributes, 1) ->
    {removed, "erl_anno:{column,line,location,text}/1 instead"};
obsolete(erl_parse, set_line, 2) ->
    {removed, "use erl_anno:set_line/2"};
obsolete(erl_scan, set_attribute, 3) ->
    {removed, "use erl_anno:set_line/2 instead"};
obsolete(erlang, get_stacktrace, 0) ->
    {removed, "use the new try/catch syntax for retrieving the stack backtrace"};
obsolete(erlang, hash, 2) ->
    {removed, "use erlang:phash2/2 instead"};
obsolete(filename, safe_relative_path, 1) ->
    {removed, "use filelib:safe_relative_path/2 instead"};
obsolete(http_uri, parse, 1) ->
    {removed, "use uri_string functions instead"};
obsolete(http_uri, parse, 2) ->
    {removed, "use uri_string functions instead"};
obsolete(http_uri, scheme_defaults, 0) ->
    {removed, "use uri_string functions instead"};
obsolete(httpd_conf, check_enum, 2) ->
    {removed, "use lists:member/2 instead"};
obsolete(httpd_conf, clean, 1) ->
    {removed, "use string:strip/1 instead or possibly the re module"};
obsolete(httpd_conf, custom_clean, 3) ->
    {removed, "use string:strip/1 instead or possibly the re module"};
obsolete(httpd_conf, is_directory, 1) ->
    {removed, "use filelib:is_dir/1 instead"};
obsolete(httpd_conf, is_file, 1) ->
    {removed, "use filelib:is_file/1 instead"};
obsolete(httpd_conf, make_integer, 1) ->
    {removed, "use erlang:list_to_integer/1 instead"};
obsolete(net, relay, 1) ->
    {removed, "use fun Relay(Pid) -> receive X -> Pid ! X end, Relay(Pid) instead"};
obsolete(public_key, ssh_decode, 2) ->
    {removed, "use ssh_file:decode/2 instead"};
obsolete(public_key, ssh_encode, 2) ->
    {removed, "use ssh_file:encode/2 instead"};
obsolete(public_key, ssh_hostkey_fingerprint, 1) ->
    {removed, "use ssh:hostkey_fingerprint/1 instead"};
obsolete(public_key, ssh_hostkey_fingerprint, 2) ->
    {removed, "use ssh:hostkey_fingerprint/2 instead"};
obsolete(rpc, safe_multi_server_call, 2) ->
    {removed, "use rpc:multi_server_call/2 instead"};
obsolete(rpc, safe_multi_server_call, 3) ->
    {removed, "use rpc:multi_server_call/3 instead"};
obsolete(ssl, cipher_suites, 0) ->
    {removed, "use cipher_suites/2,3 instead"};
obsolete(ssl, cipher_suites, 1) ->
    {removed, "use cipher_suites/2,3 instead"};
obsolete(ssl, connection_info, 1) ->
    {removed, "use ssl:connection_information/[1,2] instead"};
obsolete(ssl, negotiated_next_protocol, 1) ->
    {removed, "use ssl:negotiated_protocol/1 instead"};
obsolete(auth, node_cookie, _) ->
    {deprecated, "use erlang:set_cookie/2 and net_adm:ping/1 instead"};
obsolete(asn1ct, decode, _) ->
    {removed, "use Mod:decode/2 instead"};
obsolete(asn1ct, encode, _) ->
    {removed, "use Mod:encode/2 instead"};
obsolete(crypto, next_iv, _) ->
    {removed, "see the 'New and Old API' chapter of the CRYPTO User's guide"};
obsolete(crypto, stream_init, _) ->
    {removed, "use crypto:crypto_init/3 + crypto:crypto_update/2 + crypto:crypto_final/1 or crypto:crypto_one_time/4 instead"};
obsolete(erl_scan, attributes_info, _) ->
    {removed, "use erl_anno:{column,line,location,text}/1 instead"};
obsolete(erl_scan, token_info, _) ->
    {removed, "use erl_scan:{category,column,line,location,symbol,text}/1 instead"};
obsolete(filename, find_src, _) ->
    {removed, "use filelib:find_source/1,3 instead"};
obsolete(ssl, ssl_accept, _) ->
    {removed, "use ssl_handshake/1,2,3 instead"};
obsolete(ct_slave, _, _) ->
    {deprecated, "use ?CT_PEER(), or the 'peer' module instead", "OTP 27"};
obsolete(erts_alloc_config, _, _) ->
    {deprecated, "this module will be removed in OTP 26.0. See the documentation for details", "OTP 26"};
obsolete(gen_fsm, _, _) ->
    {deprecated, "use the 'gen_statem' module instead"};
obsolete(random, _, _) ->
    {deprecated, "use the 'rand' module instead"};
obsolete(slave, _, _) ->
    {deprecated, "use the 'peer' module instead", "OTP 27"};
obsolete(os_mon_mib, _, _) ->
    {removed, "this module was removed in OTP 22.0"};
obsolete(pg2, _, _) ->
    {removed, "this module was removed in OTP 24. Use 'pg' instead"};
obsolete(_,_,_) -> no.

-dialyzer({no_match, obsolete_type/3}).
obsolete_type(crypto, hmac_state, 0) ->
    {removed, "see the 'New and Old API' chapter of the CRYPTO User's guide"};
obsolete_type(crypto, retired_cbc_cipher_aliases, 0) ->
    {removed, "Use aes_*_cbc or des_ede3_cbc"};
obsolete_type(crypto, retired_cfb_cipher_aliases, 0) ->
    {removed, "Use aes_*_cfb8, aes_*_cfb128 or des_ede3_cfb"};
obsolete_type(crypto, retired_ctr_cipher_aliases, 0) ->
    {removed, "Use aes_*_ctr"};
obsolete_type(crypto, retired_ecb_cipher_aliases, 0) ->
    {removed, "Use aes_*_ecb"};
obsolete_type(crypto, stream_state, 0) ->
    {removed, "see the 'New and Old API' chapter of the CRYPTO User's guide"};
obsolete_type(erl_scan, column, 0) ->
    {removed, "use erl_anno:column() instead"};
obsolete_type(erl_scan, line, 0) ->
    {removed, "use erl_anno:line() instead"};
obsolete_type(erl_scan, location, 0) ->
    {removed, "use erl_anno:location() instead"};
obsolete_type(http_uri, default_scheme_port_number, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, fragment, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, host, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, path, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, query, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, scheme, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(http_uri, user_info, 0) ->
    {removed, "use uri_string instead"};
obsolete_type(_,_,_) -> no.