diff options
| author | Matthieu Moy <Matthieu.Moy@imag.fr> | 2010-07-28 09:24:27 +0200 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2010-07-28 13:56:45 -0700 |
| commit | 5bc0e247c4f281b44cfb72a5b31f479233a981f5 (patch) | |
| tree | 1223432d41b8131a73cc524353bb1c9663b1ef6c | |
| parent | 2aedccd3d51ec922020f7c7e39df5d2c4d3af515 (diff) | |
| download | git-5bc0e247c4f281b44cfb72a5b31f479233a981f5.tar.gz git-5bc0e247c4f281b44cfb72a5b31f479233a981f5.tar.xz | |
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>
| -rw-r--r-- | Documentation/git-ls-files.txt | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 3521637b5..bd919f2df 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -106,8 +106,16 @@ OPTIONS with `-s` or `-u` options does not make any sense. -t:: - Identify the file status with the following tags (followed by - a space) at the start of each line: + This feature is semi-deprecated. For scripting purpose, + linkgit:git-status[1] `--porcelain` and + linkgit:git-diff-files[1] `--name-status` are almost always + superior alternatives, and users should look at + linkgit:git-status[1] `--short` or linkgit:git-diff[1] + `--name-status` for more user-friendly alternatives. ++ +This option identifies the file status with the following tags (followed by +a space) at the start of each line: + H:: cached S:: skip-worktree M:: unmerged |