Skip to content

Commit 45a9451

Browse files
committed
Try and document how subdirs works with git repositories.
This tries to cover my confusion leading to #3162 and https://stackoverflow.com/questions/43752580/git-location-with-subdir-but-not-root-directory
1 parent 8156dd5 commit 45a9451

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

doc/yaml_configuration.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,11 @@ packages:
127127
- wai
128128
```
129129

130+
If unspecified, `subdirs` defaults to `['.']` (i.e. look only in the top-level
131+
directory). Note that if you specify a value of `subdirs`, then `'.'` is _not_
132+
included by default and needs to be explicitly specified if a required package
133+
is found in the top-level directory of the repository.
134+
130135
#### Local dependency packages (`extra-dep`)
131136
A `location` key can be accompanied by an `extra-dep` key. When the
132137
`extra-dep` key is set to `true` it indicates that the package should be

0 commit comments

Comments
 (0)