Skip to content

Commit

Permalink
Update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
Guillaume Petiot committed Sep 15, 2023
1 parent d3efd79 commit 580a684
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions doc/manpage_ocamlformat.mld
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,9 @@ OPTIONS (CODE FORMATTING STYLE)
no project root and no ocamlformat file has been found, and if the
option enable-outside-detected-project is set, the global ocamlformat
file defined in $XDG_CONFIG_HOME (or in $HOME/.config if
$XDG_CONFIG_HOME is undefined) is used.
$XDG_CONFIG_HOME is undefined) is used. In the next release,
Ocamlformat will be enabled by default, the presence of a project root
will not be checked unless [--on-save] is used.

If the disable option is not set, an .ocamlformat-ignore file
specifies files that OCamlFormat should ignore. Each line in an
Expand Down Expand Up @@ -547,7 +549,9 @@ OPTIONS
parents they are applied, if no .ocamlformat file is found then
the global configuration defined in $XDG_CONFIG_HOME/.ocamlformat
(or in $HOME/.config/.ocamlformat if $XDG_CONFIG_HOME is
undefined) is applied.
undefined) is applied. In the next release, Ocamlformat will be
enabled by default, the presence of a project root will not be
checked unless --on-save is used.

-g, --debug
Generate debugging output. The flag is unset by default.
Expand Down Expand Up @@ -617,6 +621,10 @@ OPTIONS
max_indent is an alias for max-indent. strict_with sets
function-indent-nested and match-indent-nested.

--on-save
Make OCamlformat not format if no .ocamlformat file could be
found. For code editors.

--print-config
Print the configuration determined by the environment variable,
the configuration files, preset profiles and command line.
Expand Down

0 comments on commit 580a684

Please sign in to comment.