Re: [PATCH v2] Document ls-files -t as semi-obsolete.
- From
Michele Ballabio <barra_cuda@katamail.com>
- Date
- Jul 27, 2010, 19:07 UTC
- Message-ID
- <201007272107.50204.barra_cuda@katamail.com>
- In-Reply-To
- <1280162391-18701-1-git-send-email-Matthieu.Moy@imag.fr>
On Monday 26 July 2010, Matthieu Moy wrote:
Show 20 quoted lines
> 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
I think this breaks formatting. Shouldn't it be more like the following? (I.e. with a single '+' before "Identify...").
And maybe rephrase the line "Identify the file status with the following tags (followed by a space) at the start of each line" into "This option identifies..." just to set apart "semi-deprecation" and "explanation" of the option.
diff --git a/Documentation/git-ls-files.txt b/Documentation/git-ls-files.txt index 3521637..ef84d41 100644 --- a/Documentation/git-ls-files.txt +++ b/Documentation/git-ls-files.txt @@ -106,15 +106,21 @@ 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: - H:: cached - S:: skip-worktree - M:: unmerged - R:: removed/deleted - C:: modified/changed - K:: to be killed - ?:: other + 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 +S:: skip-worktree +M:: unmerged +R:: removed/deleted +C:: modified/changed +K:: to be killed +?:: other -v:: Similar to `-t`, but use lowercase letters for files