summaryrefslogtreecommitdiff
path: root/commit.h
diff options
context:
space:
mode:
authorElijah Newren <newren@gmail.com>2023-01-13 04:41:52 +0000
committerJunio C Hamano <gitster@pobox.com>2023-01-13 11:55:16 -0800
commit2b02d2df2bc38048ca70c82024834995624c2f4d (patch)
treea446ca1fde83257bac40afdba81140ea841de49a /commit.h
parent2a34b3181dba0d2049dff127ee70aca0c255a7ad (diff)
ls-files: clarify descriptions of file selection options
The previous descriptions of the file selection options were very easy to misunderstand. For example: * "Show cached files in the output" This could be interpreted as meaning "show files which have been modified and git-add'ed, i.e. files which have cached changes relative to HEAD". * "Show deleted files" This could be interpreted as meaning "for each `git rm $FILE` we ran, show me $FILE" * "Show modified files" This could be interpreted as meaning "show files which have been modified and git-add'ed" or as "show me files that differ from HEAD" or as "show me undeleted files different from HEAD" (given that --deleted is a separate option), none of which are correct. Further, it's not very clear when some options only modify and/or override other options, as was the case with --ignored, --directory, and --unmerged (I've seen folks confused by each of them on the mailing list, sometimes even fellow git developers.) Tweak these definitions, and the one for --killed, to try to make them all a bit more clear. Finally, also clarify early on that duplicate reports for paths are often expected (both when (a) there are multiple entries for the file in the index -- i.e. when there are conflicts, and also (b) when the user specifies options that might pick the same file multiple times, such as `git ls-files --cached --deleted --modified` when there is a file with an unstaged deletion). Signed-off-by: Elijah Newren <newren@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Diffstat (limited to 'commit.h')
0 files changed, 0 insertions, 0 deletions