Merge branch 'maint'

lib/stdlib/src/shell_docs.erl

@@ -614,6 +614,8 @@ extract_type_specs(Module) ->
 -spec find_path(Mod :: module()) -> non_existing | file:filename_all().
 find_path(Module) ->
     maybe
+      %% This is set to non_existing by tests to generate docs without any specs
+      undefined ?= get({?MODULE, nospecs}),
       preloaded ?= code:which(Module),
       PreloadedPath = filename:join(code:lib_dir(erts),"ebin"),
       filename:join(PreloadedPath, atom_to_list(Module) ++ ".beam")

lib/stdlib/test/shell_docs_SUITE.erl

@@ -470,6 +470,7 @@ render_all(Dir) ->
             end).
 
 render_module(Mod, #docs_v1{ docs = Docs } = D) ->
+    put({shell_docs, nospecs}, non_existing),
     Opts = #{ ansi => true, columns => 80, encoding => unicode },
     case application:get_application(Mod) of
         {ok, App} ->

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_advise_4_func.txt

@@ -1,11 +1,5 @@
 
-  -spec advise(IoDevice, Offset, Length, Advise) -> ok | {error, Reason}
-                  when
-                      IoDevice :: io_device(),
-                      Offset :: integer(),
-                      Length :: integer(),
-                      Advise :: posix_file_advise(),
-                      Reason :: posix() | badarg.
+  advise(IoDevice, Offset, Length, Advise)
 
 Since:
   OTP R14B

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_allocate_3_func.txt

@@ -1,9 +1,5 @@
 
-  -spec allocate(File, Offset, Length) -> ok | {error, posix()}
-                    when
-                        File :: io_device(),
-                        Offset :: non_neg_integer(),
-                        Length :: non_neg_integer().
+  allocate(File, Offset, Length)
 
 Since:
   OTP R16B

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_altname_1_func.txt

@@ -1,5 +1,5 @@
 
-  -spec altname(Name :: name_all()) -> any().
+  altname(Name)
 
   The documentation for altname/1 is hidden. This probably means
   that it is internal and not to be used by other applications.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_group_2_func.txt

@@ -1,8 +1,4 @@
 
-  -spec change_group(Filename, Gid) -> ok | {error, Reason}
-                        when
-                            Filename :: name_all(),
-                            Gid :: integer(),
-                            Reason :: posix() | badarg.
+  change_group(Filename, Gid)
 
   Changes group of a file. See write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_mode_2_func.txt

@@ -1,9 +1,5 @@
 
-  -spec change_mode(Filename, Mode) -> ok | {error, Reason}
-                       when
-                           Filename :: name_all(),
-                           Mode :: integer(),
-                           Reason :: posix() | badarg.
+  change_mode(Filename, Mode)
 
 Since:
   OTP R14B

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_owner_2_func.txt

@@ -1,8 +1,4 @@
 
-  -spec change_owner(Filename, Uid) -> ok | {error, Reason}
-                        when
-                            Filename :: name_all(),
-                            Uid :: integer(),
-                            Reason :: posix() | badarg.
+  change_owner(Filename, Uid)
 
   Changes owner of a file. See write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_owner_3_func.txt

@@ -1,9 +1,4 @@
 
-  -spec change_owner(Filename, Uid, Gid) -> ok | {error, Reason}
-                        when
-                            Filename :: name_all(),
-                            Uid :: integer(),
-                            Gid :: integer(),
-                            Reason :: posix() | badarg.
+  change_owner(Filename, Uid, Gid)
 
   Changes owner and group of a file. See write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_owner_func.txt

@@ -1,17 +1,8 @@
 
-  -spec change_owner(Filename, Uid) -> ok | {error, Reason}
-                        when
-                            Filename :: name_all(),
-                            Uid :: integer(),
-                            Reason :: posix() | badarg.
+  change_owner(Filename, Uid)
 
   Changes owner of a file. See write_file_info/2.
 
-  -spec change_owner(Filename, Uid, Gid) -> ok | {error, Reason}
-                        when
-                            Filename :: name_all(),
-                            Uid :: integer(),
-                            Gid :: integer(),
-                            Reason :: posix() | badarg.
+  change_owner(Filename, Uid, Gid)
 
   Changes owner and group of a file. See write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_time_2_func.txt

@@ -1,9 +1,5 @@
 
-  -spec change_time(Filename, Mtime) -> ok | {error, Reason}
-                       when
-                           Filename :: name_all(),
-                           Mtime :: date_time(),
-                           Reason :: posix() | badarg.
+  change_time(Filename, Mtime)
 
   Changes the modification and access times of a file. See 
   write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_time_3_func.txt

@@ -1,10 +1,5 @@
 
-  -spec change_time(Filename, Atime, Mtime) -> ok | {error, Reason}
-                       when
-                           Filename :: name_all(),
-                           Atime :: date_time(),
-                           Mtime :: date_time(),
-                           Reason :: posix() | badarg.
+  change_time(Filename, Atime, Mtime)
 
   Changes the modification and last access times of a file. See 
   write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_change_time_func.txt

@@ -1,19 +1,10 @@
 
-  -spec change_time(Filename, Mtime) -> ok | {error, Reason}
-                       when
-                           Filename :: name_all(),
-                           Mtime :: date_time(),
-                           Reason :: posix() | badarg.
+  change_time(Filename, Mtime)
 
   Changes the modification and access times of a file. See 
   write_file_info/2.
 
-  -spec change_time(Filename, Atime, Mtime) -> ok | {error, Reason}
-                       when
-                           Filename :: name_all(),
-                           Atime :: date_time(),
-                           Mtime :: date_time(),
-                           Reason :: posix() | badarg.
+  change_time(Filename, Atime, Mtime)
 
   Changes the modification and last access times of a file. See 
   write_file_info/2.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_close_1_func.txt

@@ -1,8 +1,5 @@
 
-  -spec close(IoDevice) -> ok | {error, Reason}
-                 when
-                     IoDevice :: io_device(),
-                     Reason :: posix() | badarg | terminated.
+  close(IoDevice)
 
   Closes the file referenced by IoDevice. It mostly returns ok,
   except for some severe errors such as out of memory.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_consult_1_func.txt

@@ -1,14 +1,5 @@
 
-  -spec consult(Filename) -> {ok, Terms} | {error, Reason}
-                   when
-                       Filename :: name_all(),
-                       Terms :: [term()],
-                       Reason ::
-                           posix() |
-                           badarg | terminated | system_limit |
-                           {Line :: integer(),
-                            Mod :: module(),
-                            Term :: term()}.
+  consult(Filename)
 
   Reads Erlang terms, separated by ., from Filename. Returns one
   of the following:

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_copy_3_func.txt

@@ -1,15 +1,5 @@
 
-  -spec copy(Source, Destination, ByteCount) ->
-                {ok, BytesCopied} | {error, Reason}
-                when
-                    Source :: io_device() | Filename | {Filename, Modes},
-                    Destination ::
-                        io_device() | Filename | {Filename, Modes},
-                    Filename :: name_all(),
-                    Modes :: [mode()],
-                    ByteCount :: non_neg_integer() | infinity,
-                    BytesCopied :: non_neg_integer(),
-                    Reason :: posix() | badarg | terminated.
+  copy(Source, Destination, ByteCount)
 
   Copies ByteCount bytes from Source to Destination. Source
   and Destination refer to either filenames or IO devices from,

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_copy_func.txt

@@ -1,27 +1,9 @@
 
-  -spec copy(Source, Destination) -> {ok, BytesCopied} | {error, Reason}
-                when
-                    Source :: io_device() | Filename | {Filename, Modes},
-                    Destination ::
-                        io_device() | Filename | {Filename, Modes},
-                    Filename :: name_all(),
-                    Modes :: [mode()],
-                    BytesCopied :: non_neg_integer(),
-                    Reason :: posix() | badarg | terminated.
+  copy(Source, Destination)
 
   There is no documentation for copy(Source, Destination, infinity)
 
-  -spec copy(Source, Destination, ByteCount) ->
-                {ok, BytesCopied} | {error, Reason}
-                when
-                    Source :: io_device() | Filename | {Filename, Modes},
-                    Destination ::
-                        io_device() | Filename | {Filename, Modes},
-                    Filename :: name_all(),
-                    Modes :: [mode()],
-                    ByteCount :: non_neg_integer() | infinity,
-                    BytesCopied :: non_neg_integer(),
-                    Reason :: posix() | badarg | terminated.
+  copy(Source, Destination, ByteCount)
 
   Copies ByteCount bytes from Source to Destination. Source
   and Destination refer to either filenames or IO devices from,

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_datasync_1_func.txt

@@ -1,8 +1,5 @@
 
-  -spec datasync(IoDevice) -> ok | {error, Reason}
-                    when
-                        IoDevice :: io_device(),
-                        Reason :: posix() | badarg | terminated.
+  datasync(IoDevice)
 
 Since:
   OTP R14B

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_date_time_0_type.txt

@@ -1,4 +1,4 @@
 
-  -type date_time() :: calendar:datetime().
+  date_time()
 
   Must denote a valid date and time.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_del_dir_1_func.txt

@@ -1,6 +1,5 @@
 
-  -spec del_dir(Dir) -> ok | {error, Reason}
-                   when Dir :: name_all(), Reason :: posix() | badarg.
+  del_dir(Dir)
 
   Tries to delete directory Dir. The directory must be empty
   before it can be deleted. Returns ok if successful.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_del_dir_r_1_func.txt

@@ -1,6 +1,5 @@
 
-  -spec del_dir_r(File) -> ok | {error, Reason}
-                     when File :: name_all(), Reason :: posix() | badarg.
+  del_dir_r(File)
 
 Since:
   OTP 23.0

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_delete_2_func.txt

@@ -1,9 +1,5 @@
 
-  -spec delete(Filename, Opts) -> ok | {error, Reason}
-                  when
-                      Filename :: name_all(),
-                      Opts :: [delete_option()],
-                      Reason :: posix() | badarg.
+  delete(Filename, Opts)
 
 Since:
   OTP 24.0

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_delete_func.txt

@@ -1,14 +1,9 @@
 
-  -spec delete(Filename) -> ok | {error, Reason}
-                  when Filename :: name_all(), Reason :: posix() | badarg.
+  delete(Filename)
 
   There is no documentation for delete(Filename, [])
 
-  -spec delete(Filename, Opts) -> ok | {error, Reason}
-                  when
-                      Filename :: name_all(),
-                      Opts :: [delete_option()],
-                      Reason :: posix() | badarg.
+  delete(Filename, Opts)
 
 Since:
   OTP 24.0

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_eval_1_func.txt

@@ -1,13 +1,5 @@
 
-  -spec eval(Filename) -> ok | {error, Reason}
-                when
-                    Filename :: name_all(),
-                    Reason ::
-                        posix() |
-                        badarg | terminated | system_limit |
-                        {Line :: integer(),
-                         Mod :: module(),
-                         Term :: term()}.
+  eval(Filename)
 
   Reads and evaluates Erlang expressions, separated by . (or ,,
   a sequence of expressions is also an expression) from Filename.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_eval_2_func.txt

@@ -1,14 +1,5 @@
 
-  -spec eval(Filename, Bindings) -> ok | {error, Reason}
-                when
-                    Filename :: name_all(),
-                    Bindings :: erl_eval:binding_struct(),
-                    Reason ::
-                        posix() |
-                        badarg | terminated | system_limit |
-                        {Line :: integer(),
-                         Mod :: module(),
-                         Term :: term()}.
+  eval(Filename, Bindings)
 
   The same as eval/1, but the variable bindings Bindings are
   used in the evaluation. For information about the variable

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_eval_func.txt

@@ -1,13 +1,5 @@
 
-  -spec eval(Filename) -> ok | {error, Reason}
-                when
-                    Filename :: name_all(),
-                    Reason ::
-                        posix() |
-                        badarg | terminated | system_limit |
-                        {Line :: integer(),
-                         Mod :: module(),
-                         Term :: term()}.
+  eval(Filename)
 
   Reads and evaluates Erlang expressions, separated by . (or ,,
   a sequence of expressions is also an expression) from Filename.
@@ -30,16 +22,7 @@
   The encoding of Filename can be set by a comment, as described
   in epp.
 
-  -spec eval(Filename, Bindings) -> ok | {error, Reason}
-                when
-                    Filename :: name_all(),
-                    Bindings :: erl_eval:binding_struct(),
-                    Reason ::
-                        posix() |
-                        badarg | terminated | system_limit |
-                        {Line :: integer(),
-                         Mod :: module(),
-                         Term :: term()}.
+  eval(Filename, Bindings)
 
   The same as eval/1, but the variable bindings Bindings are
   used in the evaluation. For information about the variable

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_fd_0_type.txt

@@ -1,4 +1,4 @@
 
-  -type fd() :: file_descriptor().
+  fd()
 
   A file descriptor representing a file opened in raw mode.

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_file_descriptor_0_type.txt

@@ -1,5 +1,5 @@
 
-  -type file_descriptor() :: #file_descriptor{}.
+  file_descriptor()
 
   The documentation for file_descriptor/0 is hidden. This probably
   means that it is internal and not to be used by other

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_filename_0_type.txt

@@ -1,5 +1,5 @@
 
-  -type filename() :: string().
+  filename()
 
   A file name as returned from file API functions.
 

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_filename_all_0_type.txt

@@ -1,5 +1,5 @@
 
-  -type filename_all() :: string() | (RawFilename :: binary()).
+  filename_all()
 
   A file name as returned from file API functions.
 

lib/stdlib/test/shell_docs_SUITE_data/kernel_file_format_error_1_func.txt

@@ -1,13 +1,5 @@
 
-  -spec format_error(Reason) -> Chars
-                        when
-                            Reason ::
-                                posix() |
-                                badarg | terminated | system_limit |
-                                {Line :: integer(),
-                                 Mod :: module(),
-                                 Term :: term()},
-                            Chars :: string().
+  format_error(Reason)
 
   Given the error reason returned by any function in this module,
   returns a descriptive string of the error in English.