diff doc/lawrencium.txt @ 71:1fbba48019b5

MQ support: - Added `Hgqseries` command to navigate MQ series. - Ability to go to, rename, and edit the message of a patch. - Wrote documentation. Fixed a bug with the `Hgstatus` being `readonly`.
author Ludovic Chabant <ludovic@chabant.com>
date Sun, 16 Feb 2014 16:00:16 -0800
parents 16e873b2a4a8
children 785d1a1faa6c
line wrap: on
line diff
--- a/doc/lawrencium.txt	Sat Nov 09 13:20:17 2013 -0800
+++ b/doc/lawrencium.txt	Sun Feb 16 16:00:16 2014 -0800
@@ -29,7 +29,8 @@
 3.  Status Window           |lawrencium-status-window|
 4.  Log Window              |lawrencium-log-window|
 5.  Annotate Window         |lawrencium-annotate-window|
-6.  Global Settings         |lawrencium-global-settings|
+6.  MQ Series Window        |lawrencium-mqseries-window|
+7.  Global Settings         |lawrencium-global-settings|
 
 
 =============================================================================
@@ -184,6 +185,11 @@
                         provided with repository-relative names. If no file is
                         given, the search will be run in the whole repository.
 
+                                                *:Hgqseries*
+:Hgqseries              If you have the 'mq' extension enabled, show the
+                        current patch series, with indicators about which
+                        patches are applied, and which ones are not.
+
 
 =============================================================================
 3.  Status Window                               *lawrencium-status-window*
@@ -324,7 +330,33 @@
 
 
 =============================================================================
-6.  Global Settings                             *lawrencium-global-settings*
+6.  MQ Series Window                            *lawrencium-mqseries-window*
+
+The following commands are available in a |:Hgqseries| window along with the
+specified keyboard mappings, unless the |lawrencium_define_mappings| setting
+is set to `0`.
+
+                                                *Hgqseriesgoto*
+:Hgqseriesgoto          Go to the patch under the cursor.
+                        Mapped to |<C-g>|.
+
+                                                *Hgqserieseditmessage*
+:Hgqserieseditmessage   Edit the commit message for the top patch, if any.
+                        Mapped to |<C-e>|.
+
+                                                *Hgqseriesrename*
+:Hgqseriesrename {name}
+                        Rename the patch under the cursor with the given name.
+
+                                                *lawrencium-mqseries-mappings*
+A few other mappings are available in the MQ series window:
+
+    q                   Quit the MQ series window.
+
+
+
+=============================================================================
+7.  Global Settings                             *lawrencium-global-settings*
 
 The following global settings can be defined in your |vimrc| to change the
 default behaviour of Lawrencium.