Add a test case for labels references

Julow · Julow · commit 809c4ca3ffeb · 2021-05-12T18:02:42.000+02:00
- The two references in N are wrong, both are pointing to
  '../index.html#B', should be '#B' and '../M/index.html#B'.

- Label defined in top-comment can't be referenced.

- Reference paths are correct.
diff --git a/test/xref2/labels.t/run.t b/test/xref2/labels.t/run.t
@@ -0,0 +1,62 @@
+
+  $ compile test.mli
+  File "test.mli", line 18, characters 6-10:
+  Reference to 'B' is ambiguous. Please specify its kind: section-B, section-B.
+
+Labels:
+Some are not in order because the 'doc' field appears after the rest in the output.
+
+  $ odoc_print test.odocl | jq -c '.. | .["`Heading"]? | select(.) | .[1]["`Label"]'
+  [{"`Root":[{"`RootPage":"test"},"Test"]},"B"]
+  [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"D"]
+  [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"B"]
+  [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]},"C"]
+  [{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"N"]},"B"]
+  [{"`Root":[{"`RootPage":"test"},"Test"]},"A"]
+
+References to the labels:
+We expect resolved references and the heading text filled in.
+
+  $ odoc_print test.odocl | jq -c '.. | .["`Reference"]? | select(.)'
+  [{"`Resolved":{"`Identifier":{"`Label":[{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"N"]},"B"]}}},[{"`Word":"An"},"`Space",{"`Word":"other"},"`Space",{"`Word":"conflicting"},"`Space",{"`Word":"label"}]]
+  [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"B"]}},[]]
+  [{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"A"]}}},[{"`Word":"First"},"`Space",{"`Word":"label"}]]
+  [{"`Resolved":{"`Identifier":{"`Label":[{"`Root":[{"`RootPage":"test"},"Test"]},"B"]}}},[{"`Word":"Floating"},"`Space",{"`Word":"label"}]]
+  [{"`Dot":[{"`Root":["M","`TUnknown"]},"C"]},[]]
+  [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"D"]}},[]]
+  [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"M"]}},"B"]}},[]]
+  [{"`Resolved":{"`Label":[{"`Identifier":{"`Module":[{"`Root":[{"`RootPage":"test"},"Test"]},"N"]}},"B"]}},[]]
+
+  $ odoc html-generate --indent -o html test.odocl
+
+There are two references in N, one should point to a local label and the other to M.
+
+  $ cat html/test/Test/N/index.html
+  <!DOCTYPE html>
+  <html xmlns="http://www.w3.org/1999/xhtml">
+   <head><title>N (test.Test.N)</title>
+    <link rel="stylesheet" href="../../../odoc.css"/><meta charset="utf-8"/>
+    <meta name="generator" content="odoc %%VERSION%%"/>
+    <meta name="viewport" content="width=device-width,initial-scale=1.0"/>
+    <script src="../../../highlight.pack.js"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+   </head>
+   <body class="odoc">
+    <nav class="odoc-nav"><a href="../index.html">Up</a> – 
+     <a href="../../index.html">test</a> &#x00BB; 
+     <a href="../index.html">Test</a> &#x00BB; N
+    </nav>
+    <header class="odoc-preamble">
+     <h1>Module <code><span>Test.N</span></code></h1>
+    </header>
+    <nav class="odoc-toc">
+     <ul><li><a href="#B">An other conflicting label</a></li></ul>
+    </nav>
+    <div class="odoc-content">
+     <h2 id="B"><a href="#B" class="anchor"></a>An other conflicting label</h2>
+     <p><a href="../index.html#B">An other conflicting label</a> 
+      <a href="../index.html#B"><code>M:B</code></a>
+     </p>
+    </div>
+   </body>
+  </html>
diff --git a/test/xref2/labels.t/test.mli b/test/xref2/labels.t/test.mli
@@ -0,0 +1,23 @@
+(** {1:A First label} *)
+
+(** {1:B Floating label} *)
+
+module M : sig
+  (** {1:C First label of M} *)
+
+  (** {1:D Floating label in M} *)
+
+  (** {1:B Potentially conflicting label} *)
+end
+
+module N : sig
+  (** *)
+
+  (** {1:B An other conflicting label} *)
+
+  (** {!B} {!M.B} *)
+end
+
+(** References to the labels:
+
+    {!A} {!B} {!M.C} {!M.D} {!M.B} {!N.B} *)
