File: run.t

package info (click to toggle)
ocaml-odoc 2.1.1%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 6,744 kB
  • sloc: ml: 37,049; makefile: 124; sh: 79
file content (38 lines) | stat: -rw-r--r-- 1,070 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
Let's check for expected errors.

  $ cat top1.mld
  {0 Top1}
  This is the top1 page.

We need to match parents with children
  $ odoc compile top1.mld
  $ odoc compile -I . --parent top1 sub1.mld
  ERROR: Specified parent is not a parent of this file
  [1]

This is a different code-path:
  $ odoc compile top1.mld --child foo
  $ odoc compile -I . --parent top1 sub1.mld
  ERROR: Specified parent is not a parent of this file
  [1]

And these need to specify compilation unit children as well as mld children
  $ ocamlc -c -bin-annot m1.mli
  $ odoc compile m1.cmti -I . --parent top1
  ERROR: File "m1.cmti":
  Specified parent is not a parent of this file
  [1]

Parents must be pages
  $ odoc compile top1.mld --child m1
  $ odoc compile m1.cmti -I . --parent top1
  $ odoc compile sub1.mld -I . --parent module-M1
  ERROR: Expecting page as parent
  [1]

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 resolve child reference unresolvedroot(foo)