63383a27b03d

gundo.vim: Update documentation.
[view raw] [browse files]
author Steve Losh <steve@dwaiter.com>
date Wed, 10 Nov 2010 11:29:04 -0500
parents 6a58cd3cb661
children 887d515b2f46
branches/tags (none)
files gundo.vim/index.html

Changes

--- a/gundo.vim/index.html	Fri Oct 29 16:35:33 2010 -0400
+++ b/gundo.vim/index.html	Wed Nov 10 11:29:04 2010 -0500
@@ -93,6 +93,8 @@
                             <li><a href="#gundo_preview_height">g:gundo_preview_height</a></li>
                             <li><a href="#gundo_preview_bottom">g:gundo_preview_bottom</a></li>
                             <li><a href="#gundo_right">g:gundo_right</a></li>
+                            <li><a href="#gundo_help">g:gundo_help</a></li>
+                            <li><a href="#gundo_disable">g:gundo_disable</a></li>
                         </ul>
                     </li>
                     <li><a href="#license">License</a></li>
@@ -197,8 +199,14 @@
                 </p>
 
                 <p>
-                    Pressing return on a state (or double clicking on it) will revert the contents
-                    of the file to match that state.
+                    Pressing <code>return</code> on a state (or double clicking on it) will
+                    revert the contents of the file to match that state.
+                </p>
+
+                <p>
+                    You can use <code>p</code> on a state to make the preview window show the
+                    diff between your current state and the selected state, instead of a preview
+                    of what the selected state changed.
                 </p>
 
                 <p>
@@ -274,6 +282,25 @@
                 </p>
 
                 <p>Default: 0 (off, open on the left side)</p>
+
+                <a name="gundo_help"></a>
+                <h2>g:gundo_help</h2>
+
+                <p>Set this to 0 to disable the help text in the Gundo graph window.</p>
+
+                <p>Default: 1 (show the help)</p>
+
+                <a name="gundo_disable"></a>
+                <h2>g:gundo_disable</h2>
+
+                <p>Set this to 1 to disable Gundo entirely.</p>
+
+                <p>
+                    Useful if you use the same <code>~/.vim</code> folder on
+                    multiple machines, and some of them may not have Python support.
+                </p>
+
+                <p>Default: 0 (Gundo is enabled as usual)</p>
             </section>
             <section>
                 <a name="license"></a>
@@ -315,6 +342,21 @@
                 <h1>Changelog</h1>
                 
                 <ol class="changelog">
+                    <li>v2.0.0
+                        <ul>
+                            <li>
+                                Make <code>GundoToggle</code> close the Gundo windows if they're
+                                visible but not the current window, instead of moving to them.
+                            </li>
+                            <li>Add the <code>g:gundo_disable</code> setting.</li>
+                            <li>Add the <code>g:gundo_help</code> setting.</li>
+                            <li>
+                                Add the <code>p</code> mapping to preview the result of
+                                reverting to the selected state.
+                            </li>
+                            <li>Fix movement commands with counts in the graph.</li>
+                        </ul>
+                    </li>
                     <li>v1.0.0
                         <ul>
                             <li>Initial stable release.</li>