mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity Actions

deprecate git-annex status w/o runtime warning

Browse source 
As far as I can see, git-annex status was added to support direct mode, and
like other things added for that, it ought to be deprecated.

Behavior is similar to git status --short, though not identical in a few
cases eg renamed files.

I think datalad does not use this command, although it might have in the
past. Could not find any use of it in the current datalad code.

A deprecation warning at runtime would be the next step, probably will wait
and do that for all the deprecated commands together (except findref).
This commit is contained in:
Joey Hess 2023-02-28 16:34:31 -04:00
parent 3bf2d98e9c
commit 9c3c4c1712
No known key found for this signature in database
GPG key ID: DB12DB0FF05F8F38
4 changed files with 5 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG
View file

@ -2,6 +2,8 @@ git-annex (10.20230228) UNRELEASED; urgency=medium
* Using git-annex view in an adjusted branch, or git-annex adjust in a * Using git-annex view in an adjusted branch, or git-annex adjust in a
view branch, will enter an adjusted view branch. view branch, will enter an adjusted view branch.
* status: This command is deprecated because it was only needed in direct
mode; git status --short is very similar.
-- Joey Hess <id@joeyh.name> Mon, 27 Feb 2023 12:31:14 -0400 -- Joey Hess <id@joeyh.name> Mon, 27 Feb 2023 12:31:14 -0400

2
Command/Status.hs
View file

@ -15,7 +15,7 @@ cmd :: Command
cmd = notBareRepo $ noCommit $ noMessages $ cmd = notBareRepo $ noCommit $ noMessages $
withAnnexOptions [jsonOptions] $ withAnnexOptions [jsonOptions] $
command "status" SectionCommon command "status" SectionCommon
"show the working tree status" "show the working tree status (deprecated)"
paramPaths (seek <$$> optParser) paramPaths (seek <$$> optParser)
data StatusOptions = StatusOptions data StatusOptions = StatusOptions

2
doc/git-annex-status.mdwn
View file

@ -1,6 +1,6 @@
# NAME # NAME
git-annex status - show the working tree status git-annex status - show the working tree status (deprecated)
# SYNOPSIS # SYNOPSIS

3
doc/git-annex.mdwn
View file

@ -92,8 +92,7 @@ content from the key-value store.
* `status [path ...]` * `status [path ...]`
Similar to `git status --short`, displays the status of the files in the Show the working tree status. (deprecated)
working tree.
See [[git-annex-status]](1) for details. See [[git-annex-status]](1) for details.