# HG changeset patch
# User Kevin Bullock <kbullock@ringworld.org>
# Date 1511633374 21600
# Node ID b6cdf7be4059b5abe1f2226c01f7e6314bff032d
# Parent  42df62660ac83369f861df2bdddf915de9a7cfae
doc: explain gclear more clearly (and warningly)

diff -r 42df62660ac8 -r b6cdf7be4059 hggit/__init__.py
--- a/hggit/__init__.py	Sat Nov 25 12:09:03 2017 -0600
+++ b/hggit/__init__.py	Sat Nov 25 12:09:34 2017 -0600
@@ -249,7 +249,13 @@
 
 @command('gclear')
 def gclear(ui, repo):
-    '''clear out the Git cached data'''
+    '''clear out the Git cached data
+
+    Strips all Git-related metadata from the repo, including the mapping
+    between Git and Mercurial changesets. This is an irreversible
+    destructive operation that may prevent further interaction with
+    other clones.
+    '''
     repo.ui.status(_("clearing out the git cache data\n"))
     repo.githandler.clear()