check that all children are in the search path during linking

The error is changed as child and source-children are no longer references.

Signed-off-by: Paul-Elliot <[email protected]>
Co-authored-by: Jules Aguillon <[email protected]>

Author: 2 people

src/xref2/errors.ml

@@ -292,7 +292,8 @@ type what =
   | `With_type of Cfrag.type_
   | `Module_type_expr of Component.ModuleType.expr
   | `Module_type_u_expr of Component.ModuleType.U.expr
-  | `Child of Reference.t
+  | `Child_module of string
+  | `Child_page of string
   | `Reference of Reference.t ]
 
 let report ~(what : what) ?tools_error action =
@@ -339,7 +340,8 @@ let report ~(what : what) ?tools_error action =
         r "module type expression" module_type_expr cexpr
     | `Module_type_u_expr cexpr ->
         r "module type u expression" u_module_type_expr cexpr
-    | `Child rf -> r "child reference" model_reference rf
+    | `Child_module rf -> r "child module" Astring.String.pp rf
+    | `Child_page rf -> r "child page" Astring.String.pp rf
     | `Reference ref -> r "reference" model_reference ref
   in
   match kind_of_error ~what tools_error with

src/xref2/link.ml

@@ -1010,6 +1010,23 @@ let link ~filename x y =
       if y.Lang.Compilation_unit.linked || y.hidden then y else unit x y)
 
 let page env page =
+  let () =
+    List.iter
+      (fun child ->
+        let check_resolves ~what f name =
+          match f name env with
+          | Some _ -> ()
+          | None -> Errors.report ~what `Lookup
+        in
+        match child with
+        | Page.Source_tree_child _ -> ()
+        | Page.Page_child page ->
+            check_resolves ~what:(`Child_page page) Env.lookup_page page
+        | Page.Module_child mod_ ->
+            check_resolves ~what:(`Child_module mod_) Env.lookup_root_module
+              mod_)
+      page.Lang.Page.children
+  in
   {
     page with
     Page.content = comment_docs env page.Page.name page.content;

test/pages/errors.t/run.t

@@ -29,4 +29,6 @@ Parents must be pages
 Linking checks the children are all present:
   $ odoc compile top1.mld --child foo
   $ odoc link page-top1.odoc -I .
+  File "page-top1.odoc":
+  Warning: Failed to lookup child page foo