Document file exclusion #647
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MichaReiser
force-pushed
the
micha/include-excluede
branch
from
a07b121 to
832029a
Compare
sharkdp
approved these changes
Jun 14, 2025
docs/README.md
Outdated
|
|
||
| Both `include` and `exclude` support gitignore like glob patterns: | ||
|
|
||
| - `src/` matches only a directory |
Contributor
There was a problem hiding this comment.
Should this maybe describe whether or not the directory contents would be affected?
dhruvmanila
reviewed
Jun 17, 2025
docs/README.md
Outdated
| - `src` matches files or directories named `src` | ||
| - `*` matches any (possibly empty) sequence of characters (except `/`). | ||
| - `**` matches zero or more path components. | ||
| This sequence **must** form a single path component, so both `**a` and `b**` are invalid and will result in an error. |
Member
There was a problem hiding this comment.
I'm very confused by this examples (**a, b**), is there some kind of context that's required here? Would it be useful to include a directory tree as an example where this example is relevant?
Member
Author
There was a problem hiding this comment.
I don't think a directory tree would help here. These patterns are not valid syntax. ** can only be used like /**/a but not inside a path component
dhruvmanila
reviewed
Jun 17, 2025
MichaReiser
force-pushed
the
micha/include-excluede
branch
from
2fe1c05 to
a500a6f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Document the new
src.includeandsrc.excludefields (not yet released)Note: The
includefield is currently missing in the generated docs. It will exist once my overrides PR is merged (it's when I noticed that it's missing). This is hopefully before the next release.