Skip to content

git-check-ignore: add page #3113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 17, 2019
Merged

git-check-ignore: add page #3113

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
42c068c
git-check-ignore: add page
owenvoke Jun 17, 2019
23a7bed
git-check-ignore: fix command description
owenvoke Jun 17, 2019
816bf9f
git-check-ignore: split initial example
owenvoke Jun 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions pages/common/git-check-ignore.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# git check-ignore

> Analyse and debug Git ignore / exclude (".gitignore") files.
> More information: <https://git-scm.com/docs/git-check-ignore>.

- Check whether a file or directory is ignored:

`git check-ignore {{path/to/file_or_directory}}`

- Check whether multiple files or directories are ignored:

`git check-ignore {{path/to/file}} {{path/to/directory}}`

- Use pathnames, one per line, from stdin:
Copy link
Member

@waldyrious waldyrious Jun 17, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd suggest using either STDIN or stdin (with backticks).

Copy link
Member Author

@owenvoke owenvoke Jun 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we've previously chosen to lowercase stdin in the majority of pages. But I'll update it to use backticks.

Copy link
Member

@waldyrious waldyrious Jun 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@pxgamer make sense. Let's merge this one as-is and standardize stdin/stdout in a new PR :)

Copy link
Member

@waldyrious waldyrious Jun 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(I'm working on that, btw)

Copy link
Member

@waldyrious waldyrious Jun 17, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update: #3114


`git check-ignore --stdin < {{path/to/file_list}}`

- Do not check the index (used to debug why paths were tracked and not ignored):

`git check-ignore --no-index {{path/to/files_or_directories}}`

- Include details about the matching pattern for each path:

`git check-ignore --verbose {{path/to/files_or_directories}}`