Skip to content

Commit

Permalink
Clarification of a point in the doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AltGr committed Mar 19, 2013
1 parent 3447b71 commit 83d85fe
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
5 changes: 5 additions & 0 deletions .ocp-indent
Expand Up @@ -3,6 +3,11 @@
# Copy to the root of your project, customise, and transparently get consistent # Copy to the root of your project, customise, and transparently get consistent
# indentation on all your ocaml source files. # indentation on all your ocaml source files.


# Starting the configuration file with a preset ensures you won't fallback to
# definitions from "~/.ocp/ocp-indent.conf".
# These are `normal`, `apprentice` and `JaneStreet` and set different defaults.
normal

# Number of spaces used in all base cases, for example: # Number of spaces used in all base cases, for example:
# let foo = # let foo =
# ^^bar # ^^bar
Expand Down
9 changes: 4 additions & 5 deletions README.md
Expand Up @@ -83,11 +83,10 @@ transparently ensure consistency in projects with many contributors, without
requiring them to change their settings in any way (except that, obviously, they requiring them to change their settings in any way (except that, obviously, they
need to use ocp-indent !). need to use ocp-indent !).


ocp-indent will look for `~/.ocp/ocp-indent.conf` to setup its default, then If a `.ocp-indent` file is found in the current directory or its ancestors, it
search for a `.ocp-indent` file in the current directory and its parents, overrides definitions from `~/.ocp/ocp-indent.conf` and the built-in default.
stopping if one if found. These parameters can still, of course, be overridden The command-line can of course still be used to override parameters defined in
by the environment variable `OCP_INDENT_CONFIG` or the command-line options, in the files.
this order.


Have a look at ocp-indent's own [`.ocp-indent`](.ocp-indent) file for an Have a look at ocp-indent's own [`.ocp-indent`](.ocp-indent) file for an
example. example.
Expand Down

0 comments on commit 83d85fe

Please sign in to comment.