Rev 3774: Clarify the help text a bit. in http://bzr.arbash-meinel.com/branches/bzr/1.8-dev/dump_btree

[John Arbash Meinel]

At http://bzr.arbash-meinel.com/branches/bzr/1.8-dev/dump_btree

------------------------------------------------------------
revno: 3774
revision-id: john at arbash-meinel.com-20081010185341-bbrdlq1ydy2ovnv7
parent: john at arbash-meinel.com-20081008215612-y9v94tqxreqoangx
committer: John Arbash Meinel <john at arbash-meinel.com>
branch nick: dump_btree
timestamp: Fri 2008-10-10 13:53:41 -0500
message:
  Clarify the help text a bit.
-------------- next part --------------
=== modified file 'bzrlib/builtins.py'
--- a/bzrlib/builtins.py	2008-10-08 21:56:12 +0000
+++ b/bzrlib/builtins.py	2008-10-10 18:53:41 +0000
@@ -259,10 +259,14 @@
 
 
 class cmd_dump_btree(Command):
-    """Dump the contents of a btree index file to disk.
-
-    This is useful because the pages are compressed, so they cannot be read
-    directly anymore.
+    """Dump the contents of a btree index file to stdout.
+
+    PATH is a btree index file, it can be any URL. This includes things like
+    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
+
+    By default, the tuples stored in the index file will be displayed. With
+    --raw, we will uncompress the pages, but otherwise display the raw bytes
+    stored in the index.
     """
 
     # TODO: Do we want to dump the internal nodes as well?