Clarify documentation of fast-import's D subcommand
authorShawn O. Pearce <spearce@spearce.org>
Tue, 10 Jul 2007 01:27:55 +0000 (21:27 -0400)
committerShawn O. Pearce <spearce@spearce.org>
Tue, 10 Jul 2007 01:27:55 +0000 (21:27 -0400)
The 'D' subcommand within a commit can also delete a directory
recursively.  This wasn't clear in the prior version of the
documentation, leading to a question on the mailing list.

Signed-off-by: Shawn O. Pearce <spearce@spearce.org>
Documentation/git-fast-import.txt

index 8d06775a6bd5f4ac8bd5a20fba67f76c121380ee..87e70fe12d09e8e4f2b1995967d9fc1180907190 100644 (file)
@@ -481,8 +481,9 @@ It is recommended that `<path>` always be encoded using UTF-8.
 
 `filedelete`
 ^^^^^^^^^^^^
-Included in a `commit` command to remove a file from the branch.
-If the file removal makes its directory empty, the directory will
+Included in a `commit` command to remove a file or recursively
+delete an entire directory from the branch.  If the file or directory
+removal makes its parent directory empty, the parent directory will
 be automatically removed too.  This cascades up the tree until the
 first non-empty directory or the root is reached.
 
@@ -490,7 +491,8 @@ first non-empty directory or the root is reached.
        'D' SP <path> LF
 ....
 
-here `<path>` is the complete path of the file to be removed.
+here `<path>` is the complete path of the file or subdirectory to
+be removed from the branch.
 See `filemodify` above for a detailed description of `<path>`.
 
 `filedeleteall`