From: Matthieu Moy <Matthieu.Moy@imag.fr>
To: git@vger.kernel.org, gitster@pobox.com
Cc: Matthieu Moy <Matthieu.Moy@imag.fr>
Subject: [PATCH v2] Document ls-files -t as semi-obsolete.
Date: Mon, 26 Jul 2010 18:39:51 +0200 [thread overview]
Message-ID: <1280162391-18701-1-git-send-email-Matthieu.Moy@imag.fr> (raw)
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>
---
Resurecting a very old patch:
http://thread.gmane.org/gmane.comp.version-control.git/144874
The earlier concerns were:
1) There are valid uses for "git ls-files -t" and
2) If documentation is bad, then it should be improved.
This version should adress 1) by mitigating the wording (deprecated ->
semi-deprecated, "almost always"). To answer 2), I don't think
spending energy documenting a feature that almost nobody uses is worth
it. At least, I'm not going to do it, and since nothing happened for
months, I guess no one else will.
Documentation/git-ls-files.txt | 6 ++++++
1 files changed, 6 insertions(+), 0 deletions(-)
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt
index 3521637..2cc3243 100644
--- a/Documentation/git-ls-files.txt
+++ b/Documentation/git-ls-files.txt
@@ -106,6 +106,12 @@ OPTIONS
with `-s` or `-u` options does not make any sense.
-t::
+ This feature is semi-deprecated. For scripting purpose,
+ linkgit:git-status[1] `--porcelain` is almost always a
+ superior alternative, and users should look at
+ linkgit:git-status[1] `--short` or linkgit:git-diff[1]
+ `--name-status` for more user-friendly alternatives.
+
Identify the file status with the following tags (followed by
a space) at the start of each line:
H:: cached
--
1.7.2.19.g9a302.dirty
next reply other threads:[~2010-07-26 16:40 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-07-26 16:39 Matthieu Moy [this message]
2010-07-27 17:36 ` [PATCH v2] Document ls-files -t as semi-obsolete Junio C Hamano
2010-07-27 19:07 ` Michele Ballabio
2010-07-27 21:02 ` Matthieu Moy
2010-07-27 21:11 ` [PATCH v3] " Matthieu Moy
2010-07-28 4:00 ` Jeff King
2010-07-28 7:24 ` [PATCH v4] " Matthieu Moy
2010-07-27 19:58 ` [PATCH v2] " Jeff King
2010-07-27 20:11 ` Matthieu Moy
2010-07-27 21:06 ` Jeff King
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1280162391-18701-1-git-send-email-Matthieu.Moy@imag.fr \
--to=matthieu.moy@imag.fr \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).