Skip to content

Commit bcaf60d

Browse files
committed
Man: Move compile-targets to the support section
This command shouldn't be considered legacy.
1 parent 8b10196 commit bcaf60d

File tree

2 files changed

+35
-35
lines changed

2 files changed

+35
-35
lines changed

doc/manpage.mld

+34-34
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Alternative generators:
1818
Scripting:
1919

2020
- {!"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.
21+
- {!"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.
2122
- {!"odoc-errors"} Print errors that occurred while compiling or linking.
2223
- {!"odoc-html-targets"} Print the files that would be generated by html-generate.
2324
- {!"odoc-html-url"} Resolve a reference and output its corresponding url.
@@ -28,7 +29,6 @@ Scripting:
2829

2930
Legacy pipeline:
3031

31-
- {!"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.
3232
- {!"odoc-html"} Render html files from a .odoc. link then html-generate should be used instead.
3333
- {!"odoc-html-fragment"} Generates an html fragment file from an mld one.
3434
- {!"odoc-latex"} Render latex files from a .odoc. link then latex-generate should be used instead.
@@ -431,6 +431,39 @@ OPTIONS
431431

432432
]}
433433

434+
{2 odoc compile-targets}
435+
436+
{@man[
437+
NAME
438+
odoc-compile-targets - Print the name of the file produced by compile.
439+
If -o is passed, the same path is printed but error checking is
440+
performed.
441+
442+
SYNOPSIS
443+
odoc compile-targets [OPTION]… FILE
444+
445+
ARGUMENTS
446+
-o PATH
447+
Output file path. Non-existing intermediate directories are
448+
created. If absent outputs a BASE.odoc file in the same directory
449+
as the input file where BASE is the basename of the input file.
450+
For mld files the "page-" prefix will be added if not already
451+
present in the input basename.
452+
453+
FILE (required)
454+
Input .cmti, .cmt, .cmi or .mld file.
455+
456+
OPTIONS
457+
--help[=FMT] (default=auto)
458+
Show this help in format FMT. The value FMT must be one of auto,
459+
pager, groff or plain. With auto, the format is pager or plain
460+
whenever the TERM env var is dumb or undefined.
461+
462+
--version
463+
Show version information.
464+
465+
]}
466+
434467
{2 odoc errors}
435468

436469
{@man[
@@ -710,39 +743,6 @@ OPTIONS
710743

711744
{1 Legacy pipeline}
712745

713-
{2 odoc compile-targets}
714-
715-
{@man[
716-
NAME
717-
odoc-compile-targets - Print the name of the file produced by compile.
718-
If -o is passed, the same path is printed but error checking is
719-
performed.
720-
721-
SYNOPSIS
722-
odoc compile-targets [OPTION]… FILE
723-
724-
ARGUMENTS
725-
-o PATH
726-
Output file path. Non-existing intermediate directories are
727-
created. If absent outputs a BASE.odoc file in the same directory
728-
as the input file where BASE is the basename of the input file.
729-
For mld files the "page-" prefix will be added if not already
730-
present in the input basename.
731-
732-
FILE (required)
733-
Input .cmti, .cmt, .cmi or .mld file.
734-
735-
OPTIONS
736-
--help[=FMT] (default=auto)
737-
Show this help in format FMT. The value FMT must be one of auto,
738-
pager, groff or plain. With auto, the format is pager or plain
739-
whenever the TERM env var is dumb or undefined.
740-
741-
--version
742-
Show version information.
743-
744-
]}
745-
746746
{2 odoc html}
747747

748748
{@man[

src/odoc/bin/main.ml

+1-1
Original file line numberDiff line numberDiff line change
@@ -871,7 +871,7 @@ let () =
871871
Odoc_manpage.targets ~docs:section_support;
872872
Odoc_latex.targets ~docs:section_support;
873873
Depends.Compile.(cmd, info ~docs:section_support);
874-
Targets.Compile.(cmd, info ~docs:section_legacy);
874+
Targets.Compile.(cmd, info ~docs:section_support);
875875
Html_fragment.(cmd, info ~docs:section_legacy);
876876
Odoc_html.process ~docs:section_legacy;
877877
Odoc_manpage.process ~docs:section_legacy;

0 commit comments

Comments
 (0)