deprecate git-annex status w/o runtime warning

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).

diff --git a/CHANGELOG b/CHANGELOG
index dc484427380fcceea01eff5794e86e544a81d26f..443ab2c962c863c140f991c420b6795e889f5991 100644 (file)
--- a/CHANGELOG
+++ b/CHANGELOG
@@ -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
     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
 

diff --git a/Command/Status.hs b/Command/Status.hs
index 0cb1cb0853a8856b24ab12c012cff5e31b4268d6..60074846069e2a2f472e644784a01b95a4c22f3f 100644 (file)
--- a/Command/Status.hs
+++ b/Command/Status.hs
@@ -15,7 +15,7 @@ cmd :: Command
 cmd = notBareRepo $ noCommit $ noMessages $
        withAnnexOptions [jsonOptions] $
                command "status" SectionCommon
-                       "show the working tree status"
+                       "show the working tree status (deprecated)"
                        paramPaths (seek <$$> optParser)
 
 data StatusOptions = StatusOptions

diff --git a/doc/git-annex-status.mdwn b/doc/git-annex-status.mdwn
index a57e6c72cf0908697d199be88b6fed214ff39cbe..3d9a87a5324904b1b8ac936c954bcd3a537c5b32 100644 (file)
--- a/doc/git-annex-status.mdwn
+++ b/doc/git-annex-status.mdwn
@@ -1,6 +1,6 @@
 # NAME
 
-git-annex status - show the working tree status
+git-annex status - show the working tree status (deprecated)
 
 # SYNOPSIS
 

diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 36befb3753c9c89b1060ef905450d1450f063666..5e63631be7ef82bd85a8697af42904d779e1e82c 100644 (file)
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -92,8 +92,7 @@ content from the key-value store.
 
 * `status [path ...]`
 
-  Similar to `git status --short`, displays the status of the files in the
-  working tree.
+  Show the working tree status. (deprecated)
 
   See [[git-annex-status]](1) for details.