unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/dune

@@ -0,0 +1,4 @@
+(env
+ (dev
+  (odoc
+   (warnings fatal))))

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/dune-project

@@ -0,0 +1 @@
+(lang dune 2.4)

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/foo_doc/dune

@@ -0,0 +1,2 @@
+(documentation
+ (package foo_doc))

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/foo_doc/foo.mld

@@ -0,0 +1,3 @@
+{0 Foo}
+
+[doc

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/foo_lib/dune

@@ -0,0 +1,4 @@
+(library
+ (name foo)
+ (public_name foo_lib)
+ (modules_without_implementation foo))

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/foo_lib/foo.mli

@@ -0,0 +1,2 @@
+(** [t *)
+type t = int

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/run.t

@@ -0,0 +1,35 @@
+  $ export BUILD_PATH_PREFIX_MAP=odoc=`command -v odoc`
+
+As configured in the `dune` file at the root, this should be an error:
+
+  $ dune build --only-packages=foo_doc @doc
+  File "../../../../foo_doc/foo.mld", line 4, characters 0-0:
+  Error: End of text is not allowed in '[...]' (code).
+  ERROR: Warnings have been generated.
+  [1]
+
+Same for documentation in mli files:
+
+  $ dune build --only-packages=foo_lib @doc
+  File "foo_lib/foo.mli", line 1, characters 7-7:
+  Error: End of text is not allowed in '[...]' (code).
+  ERROR: Warnings have been generated.
+  [1]
+
+These packages are in a nested env, the option is disabled, should success with warning printed:
+
+  $ dune build --only-packages=bar_doc,bar_lib @doc
+  File "../../../../sub_env/bar_doc/bar.mld", line 4, characters 0-0:
+  Warning: End of text is not allowed in '[...]' (code).
+  File "sub_env/bar_lib/bar.mli", line 1, characters 7-7:
+  Warning: End of text is not allowed in '[...]' (code).
+
+In release mode, no error:
+
+  $ dune build -p foo_doc,foo_lib @doc
+  (cd _build/default/_doc/_odoc/pkg/foo_doc && odoc compile --pkg foo_doc -o page-foo.odoc ../../../../foo_doc/foo.mld)
+  File "../../../../foo_doc/foo.mld", line 4, characters 0-0:
+  Warning: End of text is not allowed in '[...]' (code).
+  (cd _build/default/foo_lib/.foo.objs/byte && odoc compile -I . -I ../../../_doc/_odoc/pkg/foo_lib --pkg foo_lib -o foo.odoc foo.cmti)
+  File "foo_lib/foo.mli", line 1, characters 7-7:
+  Warning: End of text is not allowed in '[...]' (code).

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/sub_env/bar_doc/bar.mld

@@ -0,0 +1,3 @@
+{0 Bar}
+
+[doc

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/sub_env/bar_doc/dune

@@ -0,0 +1,2 @@
+(documentation
+ (package bar_doc))

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/sub_env/bar_lib/bar.mli

@@ -0,0 +1,2 @@
+(** [t *)
+type t = int

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/sub_env/bar_lib/dune

@@ -0,0 +1,4 @@
+(library
+ (name bar)
+ (public_name bar_lib)
+ (modules_without_implementation bar))

unikernel/duniverse/dune_/test/blackbox-tests/test-cases/odoc/warnings.t/sub_env/dune

@@ -0,0 +1,4 @@
+(env
+ (dev
+  (odoc
+   (warnings nonfatal))))