Skip to content

Commit 6e33716

Browse files
committed
Clarify
1 parent 98af425 commit 6e33716

File tree

2 files changed

+8
-20
lines changed

2 files changed

+8
-20
lines changed

doc/dune

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,8 @@
88

99
(documentation
1010
(package odoc)
11-
(mld_files
12-
contributing
13-
driver
14-
dune
15-
features
16-
index
17-
interface
18-
ocamldoc_differences
19-
odoc_for_authors
20-
parent_child_spec
21-
manpage))
11+
(mld_files contributing driver dune features index interface
12+
ocamldoc_differences odoc_for_authors parent_child_spec manpage))
2213

2314
(rule
2415
(alias docgen)

src/odoc/bin/main.ml

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -447,8 +447,7 @@ end = struct
447447
let info ~docs =
448448
let doc =
449449
Format.sprintf
450-
"Print the files that would be generated by $(i,%s-generate). Works \
451-
on both $(i,.odoc) and $(i,.odocl) files."
450+
"Print the files that would be generated by $(i,%s-generate)."
452451
R.renderer.name
453452
in
454453
Term.info (R.renderer.name ^ "-targets") ~docs ~doc
@@ -760,12 +759,10 @@ module Depends = struct
760759
let info ~docs =
761760
Term.info "link-deps" ~docs
762761
~doc:
763-
"Lists the packages which need to be in odoc's load path to link the \
764-
$(i,.odoc) files in the given directory.\n\
765-
The result is not correct in case of forward references. A \
766-
conservative approximation is: any link step depends on the result \
767-
of all the compile steps that could be targeted by a forward \
768-
reference."
762+
"Lists a subset of the packages and modules which need to be in \
763+
odoc's load path to link the $(i, odoc) files in the given \
764+
directory. Additional packages may be required to resolve all \
765+
references."
769766
end
770767

771768
module Odoc_html = struct
@@ -873,12 +870,12 @@ let () =
873870
Odoc_html.targets ~docs:section_support;
874871
Odoc_manpage.targets ~docs:section_support;
875872
Odoc_latex.targets ~docs:section_support;
873+
Depends.Compile.(cmd, info ~docs:section_support);
876874
Targets.Compile.(cmd, info ~docs:section_legacy);
877875
Html_fragment.(cmd, info ~docs:section_legacy);
878876
Odoc_html.process ~docs:section_legacy;
879877
Odoc_manpage.process ~docs:section_legacy;
880878
Odoc_latex.process ~docs:section_legacy;
881-
Depends.Compile.(cmd, info ~docs:section_legacy);
882879
Depends.Link.(cmd, info ~docs:section_legacy);
883880
Css.(cmd, info ~docs:section_deprecated);
884881
Depends.Odoc_html.(cmd, info ~docs:section_deprecated);

0 commit comments

Comments
 (0)