Merge pull request #9433 from williamthome/fix/code-get-doc-cover-com…

…piled kernel: Fix `code:get_doc/1,2` when cover_compiled OTP-19513
erlang · Feb 27, 2025 · 88a7cc6 · 88a7cc6
2 parents 633e287 + 06adfb2
commit 88a7cc6
Show file tree

Hide file tree

Showing 3 changed files with 40 additions and 2 deletions.
diff --git a/lib/compiler/test/beam_doc_SUITE.erl b/lib/compiler/test/beam_doc_SUITE.erl
@@ -7,7 +7,8 @@
          private_types/1, export_all/1, equiv/1, spec/1, deprecated/1, warn_missing_doc/1,
          doc_with_file/1, doc_with_file_error/1, all_string_formats/1,
          docs_from_ast/1, spec_switch_order/1, user_defined_type/1, skip_doc/1,
-         no_doc_attributes/1, converted_metadata/1, converted_metadata_warnings/1]).
+         no_doc_attributes/1, converted_metadata/1, converted_metadata_warnings/1,
+         cover_compiled/1]).
 
 -include_lib("common_test/include/ct.hrl").
 -include_lib("kernel/include/eep48.hrl").
@@ -16,7 +17,9 @@
 -define(get_name(), atom_to_list(?FUNCTION_NAME)).
 
 all() ->
-    [{group, documentation_generation_tests}, doc_with_file].
+    [{group, documentation_generation_tests},
+     doc_with_file,
+     cover_compiled].
 
 groups() ->
     [{documentation_generation_tests, [parallel], documentation_generation_tests()}].
@@ -694,6 +697,27 @@ converted_metadata_warnings(Config) ->
 
     ok.
 
+cover_compiled(Config) ->
+    case test_server:is_cover() of
+        true ->
+            {skip, "Cover is running"};
+        false ->
+            try
+                DataDir = proplists:get_value(data_dir, Config),
+                ok = file:set_cwd(DataDir),
+
+                ModuleName = ?get_name(),
+                {ok, ModName} = default_compile_file(Config, ModuleName),
+                {ok, cover_compiled} = cover:compile(ModuleName),
+
+                {ok, #docs_v1{}} = code:get_doc(ModName),
+
+                ok
+            after
+                cover:stop()
+            end
+    end.
+
 scan_and_parse(Code) ->
     {ok, Toks, _} = erl_scan:string(Code),
     parse(Toks).

diff --git a/lib/compiler/test/beam_doc_SUITE_data/cover_compiled.erl b/lib/compiler/test/beam_doc_SUITE_data/cover_compiled.erl
@@ -0,0 +1,7 @@
+-module(cover_compiled).
+-moduledoc ~"""
+cover_compiled
+""".
+
+% SPDX-License-Identifier: Apache-2.0
+% SPDX-FileCopyrightText: 2025 Erlang/OTP and contributors
diff --git a/lib/kernel/src/code.erl b/lib/kernel/src/code.erl
@@ -1867,6 +1867,13 @@ get_doc(Mod, #{sources:=[Source|Sources]}=Options) ->
                 ErtsDir ->
                     GetDoc(filename:join([ErtsDir, "ebin", atom_to_list(Mod) ++ ".beam"]))
             end;
+        cover_compiled ->
+            case which(Mod, get_path()) of
+                non_existing ->
+                    {error, missing};
+                Fn when is_list(Fn) ->
+                    GetDoc(Fn)
+            end;
         Error when is_atom(Error) ->
             {error, Error};
         Fn ->