Skip to content

Commit a5f907a

Browse files
authored
Merge pull request #3969 from bergey/docs-stable-subdirs
docs: move details of `subdirs` adjacent usage example
2 parents 7a4b06a + ce3ef47 commit a5f907a

File tree

1 file changed

+5
-7
lines changed

1 file changed

+5
-7
lines changed

doc/yaml_configuration.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -164,11 +164,6 @@ does not rely on correct ordering in the package index, while revision
164164
number is likely simpler to use. In practice, both should guarantee
165165
equally reproducible build plans.
166166

167-
If unspecified, `subdirs` defaults to `['.']` (i.e. look only in the top-level
168-
directory). Note that if you specify a value of `subdirs`, then `'.'` is _not_
169-
included by default and needs to be explicitly specified if a required package
170-
is found in the top-level directory of the repository.
171-
172167
#### Local file path
173168

174169
Like `packages`, local file paths can be used in `extra-deps`, and
@@ -231,8 +226,11 @@ extra-deps:
231226
- wai
232227
```
233228

234-
If unspecified, `subdirs` defaults to `subdirs: [.]`, or looking for a
235-
package in the root of the repo.
229+
If unspecified, `subdirs` defaults to `['.']` meaning looking for a
230+
package in the root of the repo.. Note that if you specify a value of
231+
`subdirs`, then `'.'` is _not_ included by default and needs to be
232+
explicitly specified if a required package is found in the top-level
233+
directory of the repository.
236234

237235
#### Archives (HTTP(S) or local filepath)
238236

0 commit comments

Comments
 (0)