Skip to content

Commit

Permalink
Man: Move compile-targets to the support section
Browse files Browse the repository at this point in the history
This command shouldn't be considered legacy.
  • Loading branch information
Julow committed Nov 21, 2022
1 parent 8b10196 commit bcaf60d
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 35 deletions.
68 changes: 34 additions & 34 deletions doc/manpage.mld
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Alternative generators:
Scripting:

- {!"odoc-compile-deps"} List units (with their digest) which needs to be compiled in order to compile this one. The unit itself and its digest is also reported in the output. Dependencies between compile steps are the same as when compiling the ocaml modules.
- {!"odoc-compile-targets"} Print the name of the file produced by compile. If -o is passed, the same path is printed but error checking is performed.
- {!"odoc-errors"} Print errors that occurred while compiling or linking.
- {!"odoc-html-targets"} Print the files that would be generated by html-generate.
- {!"odoc-html-url"} Resolve a reference and output its corresponding url.
Expand All @@ -28,7 +29,6 @@ Scripting:

Legacy pipeline:

- {!"odoc-compile-targets"} Print the name of the file produced by compile. If -o is passed, the same path is printed but error checking is performed.
- {!"odoc-html"} Render html files from a .odoc. link then html-generate should be used instead.
- {!"odoc-html-fragment"} Generates an html fragment file from an mld one.
- {!"odoc-latex"} Render latex files from a .odoc. link then latex-generate should be used instead.
Expand Down Expand Up @@ -431,6 +431,39 @@ OPTIONS

]}

{2 odoc compile-targets}

{@man[
NAME
odoc-compile-targets - Print the name of the file produced by compile.
If -o is passed, the same path is printed but error checking is
performed.

SYNOPSIS
odoc compile-targets [OPTION]… FILE

ARGUMENTS
-o PATH
Output file path. Non-existing intermediate directories are
created. If absent outputs a BASE.odoc file in the same directory
as the input file where BASE is the basename of the input file.
For mld files the "page-" prefix will be added if not already
present in the input basename.

FILE (required)
Input .cmti, .cmt, .cmi or .mld file.

OPTIONS
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of auto,
pager, groff or plain. With auto, the format is pager or plain
whenever the TERM env var is dumb or undefined.

--version
Show version information.

]}

{2 odoc errors}

{@man[
Expand Down Expand Up @@ -710,39 +743,6 @@ OPTIONS

{1 Legacy pipeline}

{2 odoc compile-targets}

{@man[
NAME
odoc-compile-targets - Print the name of the file produced by compile.
If -o is passed, the same path is printed but error checking is
performed.

SYNOPSIS
odoc compile-targets [OPTION]… FILE

ARGUMENTS
-o PATH
Output file path. Non-existing intermediate directories are
created. If absent outputs a BASE.odoc file in the same directory
as the input file where BASE is the basename of the input file.
For mld files the "page-" prefix will be added if not already
present in the input basename.

FILE (required)
Input .cmti, .cmt, .cmi or .mld file.

OPTIONS
--help[=FMT] (default=auto)
Show this help in format FMT. The value FMT must be one of auto,
pager, groff or plain. With auto, the format is pager or plain
whenever the TERM env var is dumb or undefined.

--version
Show version information.

]}

{2 odoc html}

{@man[
Expand Down
2 changes: 1 addition & 1 deletion src/odoc/bin/main.ml
Original file line number Diff line number Diff line change
Expand Up @@ -871,7 +871,7 @@ let () =
Odoc_manpage.targets ~docs:section_support;
Odoc_latex.targets ~docs:section_support;
Depends.Compile.(cmd, info ~docs:section_support);
Targets.Compile.(cmd, info ~docs:section_legacy);
Targets.Compile.(cmd, info ~docs:section_support);
Html_fragment.(cmd, info ~docs:section_legacy);
Odoc_html.process ~docs:section_legacy;
Odoc_manpage.process ~docs:section_legacy;
Expand Down

0 comments on commit bcaf60d

Please sign in to comment.