Skip to content

Commit f6f092c

Browse files
committed
Correct and update stack init documentation
1 parent 315d9a1 commit f6f092c

File tree

1 file changed

+11
-8
lines changed

1 file changed

+11
-8
lines changed

doc/init_command.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,17 @@ stack init [DIR(S)] [--omit-packages] [--force] [--ignore-subdirs]
1010
(`stack.yaml`) for an existing project, based on the Cabal file or
1111
`package.yaml` file for each of its packages.
1212

13-
Stack searches for Cabal and `package.yaml` files in the current directory,
14-
unless one or more directories are specified as arguments.
13+
By default:
1514

16-
Stack also searches for Cabal and `package.yaml` files in subdirectories, unless
17-
the `--ignore-subdirs` flag is passed.
15+
* Stack searches for Cabal and `package.yaml` files in the current directory.
16+
Specify one or more directories as arguments to cause Stack to search them;
1817

19-
Stack will not overwrite an existing `stack.yaml` file, unless the `--force`
20-
flag is passed.
18+
* Stack also searches for Cabal and `package.yaml` files in subdirectories. Pass
19+
the flag `--ignore-subdirs` to ignore subdirectories;
2120

22-
Pass the `--ignore-subdirs` flag to cause Stack to ignore conflicting or
23-
incompatible user packages while initialising.
21+
* Stack will not overwrite an existing `stack.yaml` file. Pass the flag
22+
`--force` to allow overwriting; and
23+
24+
* Stack will not initialise if there are conflicting or incompatable user
25+
packages. Pass the flag `--omit-packages` to cause Stack to ignore such
26+
matters while initialising.

0 commit comments

Comments
 (0)