Document ls-files -t as semi-obsolete.
The behavior of "git ls-files -t" is very misleading (see http://thread.gmane.org/gmane.comp.version-control.git/126516 and http://thread.gmane.org/gmane.comp.version-control.git/144394/focus=144397 for examples of mislead users) and badly documented, hence we point the users to superior alternatives. The feature is marked as "semi-obsolete" but not "scheduled for removal" since it's a plumbing command, scripts might use it, and Git testsuite already uses it to test the state of the index. Signed-off-by: Matthieu Moy <Matthieu.Moy@imag.fr> Signed-off-by: Junio C Hamano <gitster@pobox.com>
Matthieu Moy committed
Jul 28, 2010 at 09:24 UTC
5bc0e247c4f281b44cfb72a5b31f479233a981f5
1 file changed
+10
-2
Documentation/git-ls-files.txt
+10
-2
@@ -106,8 +106,16 @@ OPTIONS
106
with `-s` or `-u` options does not make any sense.
107
108
-t::
109
- Identify the file status with the following tags (followed by
110
- a space) at the start of each line:
109
+ This feature is semi-deprecated. For scripting purpose,
110
+ linkgit:git-status[1] `--porcelain` and
111
+ linkgit:git-diff-files[1] `--name-status` are almost always
112
+ superior alternatives, and users should look at
113
+ linkgit:git-status[1] `--short` or linkgit:git-diff[1]
114
+ `--name-status` for more user-friendly alternatives.
115
++
116
+This option identifies the file status with the following tags (followed by
117
+a space) at the start of each line:
118
+
119
H:: cached
120
S:: skip-worktree
121
M:: unmerged