-
Notifications
You must be signed in to change notification settings - Fork 89
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Disable config file test for odoc_driver
It needs to be run manually, I could not make it run with cram tests.
- Loading branch information
Showing
11 changed files
with
40 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
Unfortunately, cram test do not work well to test `odoc_driver`, due to | ||
interaction with opam and the sandboxing. | ||
|
||
Here is how to test the "pkg_args" feature, **by hand**. | ||
|
||
From the test_odoc_driver/ folder: | ||
|
||
```shell | ||
$ opam pin . | ||
``` | ||
|
||
Have a look at the `test_odoc_driver/odoc-config.sexp` file to see how it looks | ||
|
||
```shell | ||
$ cat test_odoc_driver/odoc-config.sexp | ||
(packages brr) | ||
(libraries brr brr.poke) | ||
``` | ||
|
||
From where you want (Most likely the root of the repo): | ||
|
||
```shell | ||
$ dune exec -- odoc_driver -p test_odoc_driver -p brr --link-grep page-yo | ||
'odoc' 'link' '_odoc/test_odoc_driver/doc/page-yo.odoc' '-o' '_odoc/test_odoc_driver/doc/page-yo.odocl' '-I' '_odoc/test_odoc_driver/doc/' '-I' 'test_odoc_driver/lib/test_odoc_driver' '-P' 'brr:_odoc/brr/doc' '-P' 'test_odoc_driver:_odoc/test_odoc_driver/doc' '-L' 'brr.poke:_odoc/brr/lib/brr.poke' '-L' 'brr:_odoc/brr/lib/brr' '-L' 'test_odoc_driver:_odoc/test_odoc_driver/lib/test_odoc_driver' '--current-package' 'test_odoc_driver' '--enable-missing-root-warning' | ||
``` | ||
|
||
You can also check the references in the `yo` page resolves, by visiting the | ||
generated page! | ||
|
||
You can change the `odoc-config.sexp`, `opam upgrade test_odoc_driver` and rerun | ||
the driver to see how that affects the `-P` and `-L` values passed. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
(lang dune 3.16) | ||
|
||
(name test_odoc_driver) | ||
|
||
(generate_opam_files true) | ||
|
||
(package | ||
(name test_odoc_driver) | ||
(depends ocaml dune)) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.