Merge pull request #1254 from Julow/compat-5.3

Julow · web-flow · commit 23747f84db14 · 2024-12-05T10:52:23.000+01:00
Compatibility with OCaml 5.3
diff --git a/odoc-parser.opam b/odoc-parser.opam
@@ -14,7 +14,7 @@ dev-repo: "git+https://github.com/ocaml/odoc.git"
 doc: "https://ocaml.github.io/odoc/odoc_parser"
 depends: [
   "dune" {>= "3.7"}
-  "ocaml" {>= "4.02.0" & < "5.3"}
+  "ocaml" {>= "4.02.0" & < "5.4"}
   "astring"
   "result"
   "camlp-streams"
diff --git a/odoc.opam b/odoc.opam
@@ -45,7 +45,7 @@ depends: [
   "cppo" {build & >= "1.1.0"}
   "dune" {>= "3.7.0"}
   "fpath"
-  "ocaml" {>= "4.02.0" & < "5.3"}
+  "ocaml" {>= "4.02.0" & < "5.4"}
   "result"
   "tyxml" {>= "4.4.0"}
   "fmt"
diff --git a/src/syntax_highlighter/syntax_highlighter.ml b/src/syntax_highlighter/syntax_highlighter.ml
@@ -154,6 +154,7 @@ let tag_of_token (tok : Parser.token) =
 
 let syntax_highlighting_locs src =
   try
+    Lexer.init ();
     let lexbuf = Lexing.from_string
   #if OCAML_VERSION >= (4,8,0)
         ~with_positions:true
@@ -175,4 +176,4 @@ let syntax_highlighting_locs src =
     collect lexbuf
   with e ->
     Format.eprintf "Error during syntax highlighting: %s\n%!" (Printexc.to_string e);
-    []
+    []
diff --git a/test/generators/cases/alerts.mli b/test/generators/cases/alerts.mli
@@ -17,16 +17,12 @@ val c : int
 (* At the top-level of a module. *)
 
 module Top1 : sig
-  [@@@deprecated "A"]
-
-  (** Top-comment. *)
-end
-
-module Top2 : sig
-  [@@@deprecated "A"]
 
+  (* On OCaml 4.04 to 4.06, this top-comment is lost by the parser if there's
+     no empty line before it. *)
   (** Top-comment. *)
 end
+[@@deprecated "A"]
 
 (* Deprecated alert tag. *)
 
diff --git a/test/generators/html/Alerts-Top1.html b/test/generators/html/Alerts-Top1.html
@@ -12,10 +12,10 @@
    <a href="Alerts.html">Alerts</a> &#x00BB; Top1
   </nav>
   <header class="odoc-preamble">
-   <h1>Module <code><span>Alerts.Top1</span></code></h1><p>Top-comment.</p>
+   <h1>Module <code><span>Alerts.Top1</span></code></h1>
    <ul class="at-tags">
     <li class="deprecated"><span class="at-tag">deprecated</span> A</li>
-   </ul>
+   </ul><p>Top-comment.</p>
   </header><div class="odoc-content"></div>
  </body>
 </html>
diff --git a/test/generators/html/Alerts-Top2.html b/test/generators/html/Alerts-Top2.html
diff --git a/test/generators/html/Alerts.html b/test/generators/html/Alerts.html
@@ -57,20 +57,7 @@ <h1>Module <code><span>Alerts</span></code></h1>
        <span class="keyword">end</span>
       </span>
      </code>
-    </div><div class="spec-doc"><p>Top-comment.</p></div>
-   </div>
-   <div class="odoc-spec">
-    <div class="spec module anchored" id="module-Top2">
-     <a href="#module-Top2" class="anchor"></a>
-     <code>
-      <span><span class="keyword">module</span> 
-       <a href="Alerts-Top2.html">Top2</a>
-      </span>
-      <span> : <span class="keyword">sig</span> ... 
-       <span class="keyword">end</span>
-      </span>
-     </code>
-    </div><div class="spec-doc"><p>Top-comment.</p></div>
+    </div>
    </div>
    <div class="odoc-spec">
     <div class="spec value anchored" id="val-d">
diff --git a/test/generators/html/alerts.targets b/test/generators/html/alerts.targets
@@ -1,3 +1,2 @@
 Alerts.html
 Alerts-Top1.html
-Alerts-Top2.html
diff --git a/test/generators/latex/Alerts.tex b/test/generators/latex/Alerts.tex
@@ -15,11 +15,7 @@ \section{Module \ocamlinlinecode{Alerts}}\label{Alerts}%
 \end{ocamlindent}%
 \medbreak
 \label{Alerts-module-Top1}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Alerts-Top1]{\ocamlinlinecode{Top1}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\end{ocamlindent}%
-\ocamlcodefragment{\ocamltag{keyword}{end}}\begin{ocamlindent}Top-comment.\end{ocamlindent}%
-\medbreak
-\label{Alerts-module-Top2}\ocamlcodefragment{\ocamltag{keyword}{module} \hyperref[Alerts-Top2]{\ocamlinlinecode{Top2}}}\ocamlcodefragment{ : \ocamltag{keyword}{sig}}\begin{ocamlindent}\end{ocamlindent}%
-\ocamlcodefragment{\ocamltag{keyword}{end}}\begin{ocamlindent}Top-comment.\end{ocamlindent}%
-\medbreak
+\ocamlcodefragment{\ocamltag{keyword}{end}}\\
 \label{Alerts-val-d}\ocamlcodefragment{\ocamltag{keyword}{val} d : int}\begin{ocamlindent}\begin{description}\kern-\topsep
 \makeatletter\advance\@topsepadd-\topsep\makeatother% topsep is hardcoded
 \item[{deprecated}]{A deprecated alert d}\end{description}%
diff --git a/test/generators/link.dune.inc b/test/generators/link.dune.inc
@@ -708,7 +708,7 @@
 (subdir
  html
  (rule
-  (targets Alerts.html.gen Alerts-Top1.html.gen Alerts-Top2.html.gen)
+  (targets Alerts.html.gen Alerts-Top1.html.gen)
   (action
    (run
     odoc
@@ -732,12 +732,6 @@
   (alias runtest)
   (action
    (diff Alerts-Top1.html Alerts-Top1.html.gen))
-  (enabled_if
-   (>= %{ocaml_version} 4.04)))
- (rule
-  (alias runtest)
-  (action
-   (diff Alerts-Top2.html Alerts-Top2.html.gen))
   (enabled_if
    (>= %{ocaml_version} 4.04))))
 
@@ -791,7 +785,7 @@
 (subdir
  man
  (rule
-  (targets Alerts.3o.gen Alerts.Top1.3o.gen Alerts.Top2.3o.gen)
+  (targets Alerts.3o.gen Alerts.Top1.3o.gen)
   (action
    (run odoc man-generate -o . --extra-suffix gen %{dep:../alerts.odocl}))
   (enabled_if
@@ -806,12 +800,6 @@
   (alias runtest)
   (action
    (diff Alerts.Top1.3o Alerts.Top1.3o.gen))
-  (enabled_if
-   (>= %{ocaml_version} 4.04)))
- (rule
-  (alias runtest)
-  (action
-   (diff Alerts.Top2.3o Alerts.Top2.3o.gen))
   (enabled_if
    (>= %{ocaml_version} 4.04))))
 
diff --git a/test/generators/man/Alerts.3o b/test/generators/man/Alerts.3o
@@ -33,18 +33,6 @@ Alerts
 .nf 
 .sp 
 \f[CB]module\fR Top1 : \f[CB]sig\fR \.\.\. \f[CB]end\fR
-.fi 
-.br 
-.ti +2
-Top-comment\.
-.nf 
-.sp 
-\f[CB]module\fR Top2 : \f[CB]sig\fR \.\.\. \f[CB]end\fR
-.fi 
-.br 
-.ti +2
-Top-comment\.
-.nf 
 .sp 
 \f[CB]val\fR d : int
 .fi 
diff --git a/test/generators/man/Alerts.Top1.3o b/test/generators/man/Alerts.Top1.3o
@@ -9,11 +9,11 @@ Alerts\.Top1
 .in 
 .sp 
 .fi 
-Top-comment\.
+@deprecated: A
 .nf 
 .sp 
 .fi 
-@deprecated: A
+Top-comment\.
 .nf 
 .SH Documentation
 .sp 
diff --git a/test/generators/man/Alerts.Top2.3o b/test/generators/man/Alerts.Top2.3o
diff --git a/test/generators/man/alerts.targets b/test/generators/man/alerts.targets
@@ -1,3 +1,2 @@
 Alerts.3o
 Alerts.Top1.3o
-Alerts.Top2.3o

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,2 @@`
`1`	`1`	`Alerts.html`
`2`	`2`	`Alerts-Top1.html`
`3`		`-Alerts-Top2.html`