Mercurial > vim-lawrencium
changeset 60:137d5c895659
Updated documentation.
author | Ludovic Chabant <ludovic@chabant.com> |
---|---|
date | Wed, 14 Nov 2012 22:31:33 -0800 |
parents | 396da6e76952 |
children | ea794e48d4e2 |
files | doc/lawrencium.txt |
diffstat | 1 files changed, 47 insertions(+), 2 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/lawrencium.txt Wed Nov 14 22:30:49 2012 -0800 +++ b/doc/lawrencium.txt Wed Nov 14 22:31:33 2012 -0800 @@ -28,7 +28,8 @@ 2. Commands |lawrencium-commands| 3. Status Window |lawrencium-status-window| 4. Log Window |lawrencium-log-window| -5. Global Settings |lawrencium-global-settings| +5. Annotate Window |lawrencium-annotate-window| +6. Global Settings |lawrencium-global-settings| ============================================================================= @@ -168,6 +169,17 @@ default mappings, are available in this window. See |lawrencium-log-window|. + *:Hgannotate* +:Hgannotate Splits the current window to show annotations in the + left window. These annotation are retrieved with `hg + annotate`. + If the current file has local edits, the full output + of `hg annotate` will be opened instead, which is the + annotated parent revision. + Some extra-commands, along with some default mappings, + are available in this window. + See |lawrencium-annotate-window|. + ============================================================================= 3. Status Window *lawrencium-status-window* @@ -200,6 +212,17 @@ Similar to running |:Hgvdiff| on that file. Mapped to <CTRL-V>. + *:Hgstatusdiffsum* +:Hgstatusdiffsum Similar to |:Hgstatusdiff|, but show a diff summary, + like the one shown with |:Hgdiffsum|, instead of + running a full Vim diff. + Mapped to <CTRL-U>. + + *:Hgstatusvdiffsum* +:Hgstatusvdiffsum Similar to |:Hgstatusdiffsum|, but use a vertical + split. + Mapped to <CTRL-H>. + *:Hgstatuscommit* :Hgstatuscommit Runs |:Hgcommit| on the files currently mentioned in the buffer, or in the current selection. The first @@ -280,7 +303,21 @@ ============================================================================= -5. Global Settings *lawrencium-global-settings* +5. Annotate Window *lawrencium-annotate-window* + +The following commands are available in a |:Hgannotate| window along with the +specified keyboard mappings, unless the |lawrencium_define_mappings| setting +is set to `0`. + + *Hgannotatediffsum* +:Hgannotatediffsum Show a diff summary (similar to |:Hgdiffsum|) for the + revision mentioned under the cursor. + Mapped to |<CR>|. + + + +============================================================================= +6. Global Settings *lawrencium-global-settings* The following global settings can be defined in your |vimrc| to change the default behaviour of Lawrencium. @@ -316,5 +353,13 @@ diff diff graphlog graphlog + *lawrencium_annotate_width_offset* +g:lawrencium_annotate_width_offset + Specifies the offset to use when computing the width + of the annotations window (opened with |:Hgannotate|). + Defaults to 0. + This is useful for example if you have |'listchars'| + set to display characters at the window border when + unwrapped lines are extending outside. vim:tw=78:et:ft=help:norl: