Skip to content

Commit

Permalink
doc: document more dune describe commands (ocaml#10350)
Browse files Browse the repository at this point in the history
Signed-off-by: Antonio Nuno Monteiro <anmonteiro@gmail.com>
  • Loading branch information
anmonteiro authored Apr 1, 2024
1 parent 4ec8b98 commit eda75f7
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 4 deletions.
4 changes: 2 additions & 2 deletions bin/describe/aliases_targets.ml
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ module Aliases_cmd = struct
let term = ls_term fetch_results

let command =
let doc = "Print aliases in a given directory. Works similalry to ls." in
let doc = "Print aliases in a given directory. Works similarly to ls." in
Cmd.v (Cmd.info "aliases" ~doc ~envs:Common.envs) term
;;
end
Expand Down Expand Up @@ -134,7 +134,7 @@ module Targets_cmd = struct
let term = ls_term fetch_results

let command =
let doc = "Print targets in a given directory. Works similalry to ls." in
let doc = "Print targets in a given directory. Works similarly to ls." in
Cmd.v (Cmd.info "targets" ~doc ~envs:Common.envs) term
;;
end
2 changes: 1 addition & 1 deletion bin/describe/package_entries.ml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ let term =
;;

let command =
let doc = "prints information about the entries per package" in
let doc = "prints information about the entries per package." in
let info = Cmd.info ~doc "package-entries" in
Cmd.v info term
;;
2 changes: 1 addition & 1 deletion bin/printenv.ml
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,7 @@ let term =
;;

let command =
let doc = "Print the environment of a directory" in
let doc = "Print the environment of a directory." in
let man =
[ `S "DESCRIPTION"
; `P {|$(b,dune show env DIR) prints the environment of a directory|}
Expand Down
43 changes: 43 additions & 0 deletions doc/reference/cli.rst
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,49 @@ documentation for each command is available through ``dune COMMAND --help``.

Describe the workspace.

.. describe:: dune describe aliases

Print aliases in a given directory. Works similarly to ls.

.. describe:: dune describe env

Print the environment of a directory.

.. describe:: dune describe external-lib-deps

Print out the external libraries needed to build the project. It's an
approximated set of libraries.

.. describe:: dune describe installed-libraries

Print out the libraries installed on the system.

.. describe:: dune describe opam-files

Print information about the opam files that have been discovered.

.. describe:: dune describe package-entries

prints information about the entries per package.

.. describe:: dune describe pp

Build a given file and print the preprocessed output.

.. describe:: dune describe rules

Dump rules.

.. describe:: dune describe targets

Print targets in a given directory. Works similarly to ls.

.. describe:: dune describe workspace

Print a description of the workspace's structure. If some directories
are provided, then only those directories of the workspace are
considered.

.. describe:: dune diagnostics

Fetch and return errors from the current build.
Expand Down

0 comments on commit eda75f7

Please sign in to comment.