Skip to content

Commit

Permalink
compile-src: fix manpage
Browse files Browse the repository at this point in the history
Signed-off-by: Paul-Elliot <[email protected]>
  • Loading branch information
panglesd committed Jan 12, 2024
1 parent 5711bad commit a368576
Showing 1 changed file with 6 additions and 11 deletions.
17 changes: 6 additions & 11 deletions src/odoc/bin/main.ml
Original file line number Diff line number Diff line change
Expand Up @@ -426,19 +426,16 @@ module Compile_src = struct
Arg.(required & pos 0 (some file) None & info ~doc ~docv:"FILE" [])
in
let source_parent_file =
let doc =
".odoc file of the parent of the page containing the source code for \
this compilation unit."
in
let doc = "The source-tree file parent of the implementation." in
Arg.(
required
& opt (some convert_fpath) None
& info [ "source-parent-file" ] ~doc ~docv:"PARENT.odoc")
& info [ "source-parent-file" ] ~doc ~docv:"srctree-PARENT.odoc")
in
let source_path =
let doc =
"The basename of the source file. This is used to place the source \
file within the source_parent."
"The relative path of the source file. This is used to place the \
source file within the parent source tree."
in
Arg.(
required
Expand All @@ -452,10 +449,8 @@ module Compile_src = struct

let info ~docs =
let doc =
"Compile a source tree into a page. Expect a text file containing the \
relative paths to every source files in the source tree. The paths \
should be the same as the one passed to $(i,odoc compile \
--source-name)."
"Compile a $(i,NAME.cmt) file to a $(i,src-NAME.odoc) containing the \
implementation information needed by odoc for the compilation unit."
in
Term.info "compile-src" ~docs ~doc
end
Expand Down

0 comments on commit a368576

Please sign in to comment.