summaryrefslogtreecommitdiff
path: root/include/git2/annotated_commit.h
diff options
context:
space:
mode:
authorIgor Djordjevic <igor.d.djordjevic@gmail.com>2018-07-13 21:29:01 +0200
committerIgor Djordjevic <igor.d.djordjevic@gmail.com>2018-07-14 00:37:06 +0200
commit9cab93c0a01efd16297fb9beb29d9b059f8b5ff4 (patch)
tree0c87664bddb7e39778f8ccfd90a1dc0a9f543061 /include/git2/annotated_commit.h
parent6dfc8bc2499db78eae4e29dd121c75121f0e8baf (diff)
downloadlibgit2-9cab93c0a01efd16297fb9beb29d9b059f8b5ff4.tar.gz
ignore: improve `git_ignore_path_is_ignored` description Git analogy
In attempt to provide adequate Git command analogy in regards to ignored files handling, `git_ignore_path_is_ignored` description mentions doing `git add .` on directory containing the file, and whether the file in question would be added or not - but behavior of the two matches for untracked files only, making the comparison misleading in general sense. For tracked files, Git doesn't subject them to ignore rules, so even if a rule applies, `git add .` would actually add the tracked file changes to index, while `git_ignore_path_is_ignored` would still consider the file being ignored (as it doesn't check the index, as documented). Let's provide `git check-ignore --no-index` as analogous Git command example instead, being more aligned with what `git_ignore_path_is_ignored` is about, no matter if the file in question is already tracked or not. See issue #4720 (git_ignore_path_is_ignored documentation misleading?, 2018-07-10)[1] for additional information. [1] https://github.com/libgit2/libgit2/issues/4720
Diffstat (limited to 'include/git2/annotated_commit.h')
0 files changed, 0 insertions, 0 deletions