Skip to content

Commit a368576

Browse files
committed
compile-src: fix manpage
Signed-off-by: Paul-Elliot <peada@free.fr>
1 parent 5711bad commit a368576

File tree

1 file changed

+6
-11
lines changed

1 file changed

+6
-11
lines changed

src/odoc/bin/main.ml

Lines changed: 6 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -426,19 +426,16 @@ module Compile_src = struct
426426
Arg.(required & pos 0 (some file) None & info ~doc ~docv:"FILE" [])
427427
in
428428
let source_parent_file =
429-
let doc =
430-
".odoc file of the parent of the page containing the source code for \
431-
this compilation unit."
432-
in
429+
let doc = "The source-tree file parent of the implementation." in
433430
Arg.(
434431
required
435432
& opt (some convert_fpath) None
436-
& info [ "source-parent-file" ] ~doc ~docv:"PARENT.odoc")
433+
& info [ "source-parent-file" ] ~doc ~docv:"srctree-PARENT.odoc")
437434
in
438435
let source_path =
439436
let doc =
440-
"The basename of the source file. This is used to place the source \
441-
file within the source_parent."
437+
"The relative path of the source file. This is used to place the \
438+
source file within the parent source tree."
442439
in
443440
Arg.(
444441
required
@@ -452,10 +449,8 @@ module Compile_src = struct
452449

453450
let info ~docs =
454451
let doc =
455-
"Compile a source tree into a page. Expect a text file containing the \
456-
relative paths to every source files in the source tree. The paths \
457-
should be the same as the one passed to $(i,odoc compile \
458-
--source-name)."
452+
"Compile a $(i,NAME.cmt) file to a $(i,src-NAME.odoc) containing the \
453+
implementation information needed by odoc for the compilation unit."
459454
in
460455
Term.info "compile-src" ~docs ~doc
461456
end

0 commit comments

Comments
 (0)