[Pkg-bazaar-commits] ./bzr/unstable r466: - doc for status command

[Martin Pool]

------------------------------------------------------------
revno: 466
committer: Martin Pool <mbp at sourcefrog.net>
timestamp: Wed 2005-05-11 16:00:08 +1000
message:
  - doc for status command
modified:
  bzrlib/commands.py
-------------- next part --------------
=== modified file 'bzrlib/commands.py'
--- a/bzrlib/commands.py	2005-05-11 05:55:27 +0000
+++ b/bzrlib/commands.py	2005-05-11 06:00:08 +0000
@@ -189,9 +189,33 @@
 class cmd_status(Command):
     """Display status summary.
 
-    For each file there is a single line giving its file state and name.
-    The name is that in the current revision unless it is deleted or
-    missing, in which case the old name is shown.
+    This reports on versioned and unknown files, reporting them
+    grouped by state.  Possible states are:
+
+    added
+        Versioned in the working copy but not in the previous revision.
+
+    removed
+        Versioned in the previous revision but not versioned or deleted
+        in the working copy.
+
+    renamed
+        Path of this file changed from the previous revision;
+        the text may also have changed.  This includes files whose
+        parent directory was
+
+    modified
+        Text has changed since the previous revision.
+
+    unchanged
+        Nothing about this file has changed since the
+        previous revision.  Only shown with --all.
+
+    unknown
+        Not versioned and not matching an ignore pattern.
+
+    To see ignored files use 'bzr ignored'.  For details in the
+    changes to file texts, use 'bzr diff'.
     """
     takes_args = ['file*']
     takes_options = ['all', 'show-ids']