From 8aad98aa991c8ad57b89fd0bb89434b58f79cfc0 Mon Sep 17 00:00:00 2001 From: Etienne Millon Date: Mon, 11 Feb 2019 21:15:19 +0100 Subject: [PATCH] Format-dune-file: document that this is low level (#1828) Signed-off-by: Etienne Millon --- bin/format_dune_file.ml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/bin/format_dune_file.ml b/bin/format_dune_file.ml index 00e0b875bc8..6c08d4db4b7 100644 --- a/bin/format_dune_file.ml +++ b/bin/format_dune_file.ml @@ -8,7 +8,9 @@ let doc = "Format dune files" let man = [ `S "DESCRIPTION" ; `P {|$(b,dune format-dune-file) reads a dune file and outputs a formatted - version. |} + version. This is a low-level command, meant to implement editor + support for example. To reformat a dune project, see the "Automatic + formatting" section in the manual.|} ] let info = Term.info "format-dune-file" ~doc ~man