Skip to content

Commit

Permalink
doc: Clarify the behaviour when using both directories and finder
Browse files Browse the repository at this point in the history
Closes #945.

I originally wanted to add a warning or recommendation in the
configuration but there is a few projects consciously using this feature
and it does not feel right to add a warning for them in this scenario.
  • Loading branch information
theofidry committed Oct 15, 2023
1 parent b721bee commit a9a7e7c
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions doc/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,11 @@ compactors.
but it remains possible to include them via [`files`][files], [`files-bin`][files], `directories-bin` or your own
[`finder`][finder] or [`finder-bin`][finder].

!!! Warning
If some files are expected to be excluded from the [`finder`][finder] (respectively [`finder-bin`][finder]) but
included in `directories` (respectively `directories-bin`), the those files **will be included**. The files included
are a union of the directives.

!!! Warning
Symlinks are not followed/supported.

Expand All @@ -257,6 +262,11 @@ such as images, those that contain binary data or simply a file you do not want
Setting the key `finder` (regardless of its value), will disable the file auto-discovery. If you want
to keep it, check the [force the auto-discovery][force-autodiscovery] setting.

!!! Warning
If some files are expected to be excluded from the [`finder`][finder] (respectively [`finder-bin`][finder]) but
included in `directories` (respectively `directories-bin`), the those files **will be included**. The files included
are a union of the directives.

!!! Warning
Symlinks are not followed/supported.

Expand Down

0 comments on commit a9a7e7c

Please sign in to comment.