read-tree: deprecate syntax without tree-ish args

[git.git] / Documentation / git-read-tree.txt

diff --git a/Documentation/git-read-tree.txt b/Documentation/git-read-tree.txt
index 2e78da448f30ad260cb7683a5610f424d0c5ffea..e88e9c2d55d19844ca56bc2d5b7b683e329b6fb8 100644 (file)
--- a/Documentation/git-read-tree.txt
+++ b/Documentation/git-read-tree.txt
@@ -11,7 +11,7 @@ SYNOPSIS
 'git read-tree' [[-m [--trivial] [--aggressive] | --reset | --prefix=<prefix>]
                [-u [--exclude-per-directory=<gitignore>] | -i]]
                [--index-output=<file>] [--no-sparse-checkout]
-               <tree-ish1> [<tree-ish2> [<tree-ish3>]]
+               (--empty | <tree-ish1> [<tree-ish2> [<tree-ish3>]])
 
 
 DESCRIPTION
@@ -114,6 +114,10 @@ OPTIONS
        Disable sparse checkout support even if `core.sparseCheckout`
        is true.
 
+--empty::
+       Instead of reading tree object(s) into the index, just empty
+       it.
+
 <tree-ish#>::
        The id of the tree object(s) to be read/merged.