# HG changeset patch
# User timeless <timeless@mozdev.org>
# Date 1450826513 0
# Node ID fb2c77ba577a8818f801a06329e6d8cc134520da
# Parent  bb810c8b3ecaff986da3e2a1268e089cda4d7c8b
histedit: explain basics of histedit commands

This should be hooked into @action via an extended
help argument, but that is future work.

diff -r bb810c8b3eca -r fb2c77ba577a hgext/histedit.py
--- a/hgext/histedit.py	Wed Dec 23 07:37:45 2015 +0000
+++ b/hgext/histedit.py	Tue Dec 22 23:21:53 2015 +0000
@@ -871,8 +871,21 @@
 def histedit(ui, repo, *freeargs, **opts):
     """interactively edit changeset history
 
-    This command edits changesets between an ANCESTOR and the parent of
-    the working directory.
+    This command lets you edit a linear series of changesets (up to
+    and including the working directory, which should be clean).
+    You can::
+
+    - `pick` to [re]order a changeset
+
+    - `drop` to omit changeset
+
+    - `mess` to reword the changeset commit message
+
+    - `fold` to combine it with the preceding changeset
+
+    - `roll` like fold, but discarding this commit's description
+
+    - `edit` to edit this changeset
 
     The value from the "histedit.defaultrev" config option is used as a
     revset to select the base revision when ANCESTOR is not specified.