Skip to content

Commit

Permalink
update docs to mention .gitignore files always ignored
Browse files Browse the repository at this point in the history
  • Loading branch information
seapagan committed Jan 26, 2025
1 parent bbedb09 commit 770bcd8
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 8 deletions.
9 changes: 5 additions & 4 deletions README-cratesio.md
Original file line number Diff line number Diff line change
Expand Up @@ -387,7 +387,8 @@ while the `exclude` patterns will **replace** the default ignore list entirely.
**Important**: When the `exclude` option is used (either via command line or
config file), both the default ignore list and any `extend_exclude` patterns are
completely ignored. The `exclude` patterns become the only ignore rules in
effect.
effect **EXCEPT that in either case, files in the `.gitignore` are ALWAYS
ignored.**

**Note**: The `extend_exclude` option is useful for excluding additional files
that aren't in the default ignore list but that you don't want to include in
Expand Down Expand Up @@ -422,9 +423,9 @@ below) they will not be listed anywhere in the XML output:
alternate 'Licence' spelling.
- `.vscode` folder and it's contents

This list is hard-coded (and to be honest is tuned to my current workflow) and
cannot be changed at this time. However, that will be changed once the
configuration file functionality is added.
This list is hard-coded (and to be honest is tuned to my current workflow)
however it can be added to / replaced by the `extend_exclude` and `exclude`
options above.

I'm very open to adding other files that should be ignored by default, If you
have a suggestion, please open a PR or an Issue on GitHub. For example, tool
Expand Down
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -402,7 +402,8 @@ while the `exclude` patterns will **replace** the default ignore list entirely.
>
> When the `exclude` option is used (either via command line or config file),
> both the default ignore list and any `extend_exclude` patterns are completely
> ignored. The `exclude` patterns become the only ignore rules in effect.
> ignored. The `exclude` patterns become the only ignore rules in effect
> **EXCEPT that in either case, files in the `.gitignore` are ALWAYS ignored.**
> [!TIP]
>
Expand Down Expand Up @@ -441,9 +442,9 @@ below) they will not be listed anywhere in the XML output:
alternate 'Licence' spelling.
- `.vscode` folder and it's contents

This list is hard-coded (and to be honest is tuned to my current workflow) and
cannot be changed at this time. However, that will be changed once the
configuration file functionality is added.
This list is hard-coded (and to be honest is tuned to my current workflow)
however it can be added to / replaced by the `extend_exclude` and `exclude`
options above. **In ALL CASES, files in the `.gitignore` are ALWAYS ignored.**

> [!TIP]
>
Expand Down

0 comments on commit 770bcd8

Please sign in to comment.