Commits

ZyX_I committed b163402

Some documentation fixes

Comments (0)

Files changed (2)

 This plugin provides a vim <--> VCS (currently only mercurial) integration for 
 your projects. Features:
 
-  - Partially committing changes ([:AuRecord](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line310-0)).
+  - Partially committing changes ([:AuRecord](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line320-0)).
 
-  - Viewing file state at particular revision ([aurum://file](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line539-0), [:AuFile](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line141-0)).
+  - Viewing file state at particular revision ([aurum://file](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line551-0), [:AuFile](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line145-0)).
 
   - Viewing uncommited changes in a vimdiff, as well as changes between 
-    specific revisions ([:AuVimDiff](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line350-0)). It is also possible to open multiple 
+    specific revisions ([:AuVimDiff](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line360-0)). It is also possible to open multiple 
     tabs with all changes to all files viewed as side-by-side diffs.
 
-  - Viewing revisions log ([:AuLog](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line211-0)). Output is highly customizable.
+  - Viewing revisions log ([:AuLog](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line221-0)). Output is highly customizable.
 
-  - Viewing working directory status ([:AuStatus](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line314-0)).
+  - Viewing working directory status ([:AuStatus](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line324-0)).
 
-  - Commiting changes ([:AuCommit](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line82-0)), commit messages are remembered in case of 
-    rollback ([g:aurum_remembermsg](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line784-0)).
+  - Commiting changes ([:AuCommit](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line86-0)), commit messages are remembered in case of 
+    rollback ([g:aurum_remembermsg](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line796-0)).
 
   - Frontends for various VCS commands.
 
-Most commands can be reached with a set of mappings (see [aurum-mappings](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line681-0)), 
+Most commands can be reached with a set of mappings (see [aurum-mappings](http://vimpluginloader.sourceforge.net/doc/aurum.txt.html#line693-0)), 
 all mappings are customizable.
 
 
    get repository location from it, thus `repo' option is not needed (or is 
    even ignored). This also applies to options like `file'/`files'.
 3. Commands accepting filenames or globs also accept `:' meaning `current 
-   file'.
+   file'.                      *aurum-current-revision* *aurum-current-file*
+4. `current file' and `current revision' are determined in the following 
+   fashion:
+   1. |aurum://file|:{repo}:{rev}:{file} buffers: current revision is {rev} 
+      and current file is {file}.
+   2. |aurum://status|: current file is file under cursor and current revision 
+      is first status revision.
+   3. |aurum://diff| buffers: current file is one of the files which section 
+      is located under the cursor and current revision is either second or 
+      first diffed revision.
+   4. |aurum://annotate| buffers: current file is file under cursor (annotate 
+      may follow renames/copies; target filename is not explicitely mentioned) 
+      and current revision is revision under cursor.
+   5. For other buffers: current file is file name, current revision is 
+      working directory revision.
+5. If file argument is not specified then revision argument (if any) will be 
+   ignored for |aurum://file|, |aurum://status| and |aurum://diff| buffers.
 
 AuAnnotate [file {file}] [rev {rev}] [repo {repo}]               *:AuAnnotate*
-    Annotate rev {rev} of a file {file}. By default annotates current file:
-    - for buffers with normal files current file is determined by buffer name, 
-      default revision is working directory revision (note that mercurial does 
-      not support annotating files with uncommited changes). Same for 
-      |aurum://copy| buffers;
-    - for |aurum://file| buffers (aurum://repo:{arev}:{afile}) file is {afile} 
-      and rev is {arev};
-    - for |aurum://status| buffers file is file under cursor and rev is first 
-      status revision;
-    - for |aurum://diff| buffers file is file which diff is under cursor and 
-      rev is either second or first diffed revision.
-    Note if {file} is not specified and buffer is one of |aurum://file|, 
-         |aurum://status| or |aurum://diff|, then {rev} argument will be 
-         ignored.
+    Annotate rev {rev} of a file {file}. By default annotates current revision 
+    of a current file (|aurum-current-file|).
 
 AuCommit {options} [glob1 [glob2 [...]]]                           *:AuCommit*
     Commit files matching given globs (current file if no globs were given). 
     Constructs a URL and puts it into system clipboard (see |quote+|).
     Possible options:
     Option    Description ~
-    rev       Revision that is to be refered.
-              Default: see |:AuAnnotate| (for url=html,raw,annotate,filehist),
-                       working directory revision (for url=bundle,changeset),
-                       not applicable (for url=log,clone,push).
-    file      File that is to be refered
-              (only for url=html,raw,annotate,filehist)
-              Default: see |:AuAnnotate|.
+    rev       Revision that is to be refered. Defaults:
+                  URL types                   Default ~
+                  html,raw,annotate,filehist  |aurum-current-revision|
+                  bundle,changeset,log        working directory revision
+                  clone,push                  not applicable (not used)
+              Note: Depending on specific repository this argument may be 
+                    unsupported (mostly hgsubversion repositories), supported 
+                    only partly (mostly hg-git repositories: supported only if 
+                    revision in question has first bookmark mapping to git 
+                    branch) or under specific conditions (kenai.com requires 
+                    revision numbers matching in your and remote repository).
+    file      File that is to be refered (url=html,raw,annotate,filehist).
+              Default: see |aurum-current-file|.
     url       URL type. Accepted types (default: html):
                   Type      Description ~
                   html      URL of the file, HTML formatted
 
 AuJunk [forget] [ignore] [remove] [ignoreglobs] glob1 [...]          *:AuJunk*
     Forget, ignore or remove (default: remove) files matching given globs 
-    (specify `:' to ignore current file). With `ignoreglobs' it will ignore 
+    (specify `:' to act on current file). With `ignoreglobs' it will ignore 
     not matching files, but given globs. Unlike other commands you must 
     specify at least one glob (or `:') here, without this it will fail.
 
                 a file. May be specified more then once.
                 Note: This option also affects files shown when `stat', 
                       `patch', `showfiles', `showrenames' and `showcopies' 
-                      options are specified (unless `ignfiles' is also 
-                      present).
+                      options are specified (unless |aurum-lo-ignfiles| is 
+                      also present).
     date        String of a form y-m-d_H:M where all components except first 
                 are optional. Each of y, m, d, H, M may be either a number, 
                 a dot (meaning put current value here) and a star (meaning 
                 `any'). `y' is either a four- or two-digit year. If present, 
                 selects revisions that match given date. You can also use 
-                `>={date}', `<={date}' and `{date1}<=>{date1}' (`=' may be 
+                `>={date}', `<={date}' and `{date1}<=>{date2}' (`=' may be 
                 omitted).
     search      Regex. If present, selects revisions where description matches 
                 given regular expression.
     revision    Revision. Shows only specified revision.
     revrange    Two revisions. Shows revisions that are between specified 
                 ones.
-    [no]merges  Flag. `merges' selects revisions that more then one parent, 
-                `nomerges' selects revisions that have exactly one parent.
+    [no]merges  Flag. `merges' selects revisions with more then one parent, 
+                `nomerges' selects revisions that have one or no parents.
     style       String. Specifies template name, see |aurum-logstyles|.
     template    Variable name. Specifies variable from which template should 
                 be loaded.
 AuVimDiff {opts} [rev1 [...]]                                     *:AuVimDiff*
     Opens a vimdiff windows. Possible options:
     Option       Description ~
-    file         File to be opened. Default: current file (see |:AuAnnotate|).
+    file         File to be opened. Default: |aurum-current-file|.
                  Not used when `full' option is enabled.
     files        Pattern, determines files to be opened. Default: all files.
                  Not used when `full' option is disabled.
     [no]curfile  Determines whether current state of the file should be used.
     [no]usewin   Overrides |g:aurum_usewin|. Determines whether new window 
                  should be opened instead of using existing one. First file 
-                 will always be opened in current window.
+                 will always be opened in current window unless `full' is 
+                 enabled.
     [no]full     If enabled, opens multiple tabs containing all files changed 
                  between selected revisions (revisions and working directory 
-                 state if `curfile' is enabled). Overrides `file' option.
+                 state if `curfile' is enabled). Overrides `file' option, 
+                 makes |g:aurum_usewin| and `usewin' options not applicable.
     [no]onlymodified
                  Determines whether removed and added files should be included 
                  in the full diff (default: not included: option enabled).
                  Disables `onlymodified' option.
     repo         Path. Repository that should be used.
 
-    Note: if less then two revisions were specified, one will be working 
-          directory state or current revision (see |:AuAnnotate|) and second 
-          will either be working directory revision or, if it is equal to 
-          current revision, its first parent.
+    Note: if less then two revisions (or one revision and `curfile') were 
+          specified, one will be working directory state or current revision 
+          (see |aurum-current-revision|) and second (unless one revision is 
+          specified) will either be working directory revision or, if it is 
+          equal to current revision, its first parent.
                           *g:frawormap_AuVimDiff* *g:frawormap_AuVimDiff_Exit*
     :AuVimDiff command defines Exit mappings for all opened buffers. By 
     default lhs of this mapping is `X' with leader `<Leader>' (`<Leader>X'), 
     but this can be customized using g:frawormap_AuVimDiff and 
-    g:frawormap_AuVimDiff_Exit variables.
+    g:frawormap_AuVimDiff_Exit variables. This mapping will disable diff, 
+    close (and, possibly, wipe out) opened buffers and try to restore view 
+    state of the first buffer (unless it was opened by :AuVimDiff).
 
 ------------------------------------------------------------------------------
 2.2. Functions                                               *aurum-functions*
 starting with aurum://. Some things you should know:
 - If pseudo-protocol supports more then one argument, in all but last 
   arguments colons and backslashes should be escaped. In a last argument you 
-  should not escape anything (unless this argument is an options dictionary).
+  may not escape anything (unless this argument is an options dictionary).
 - While all commands take filenames relative to current directory, all 
   pseudo-protocols should be passed filenames relative to repository root.
 - None of pseudo-protocols accepts globs outside of {opts}.
   backslashes and colons. If command accepts {diffopts} then they can also be 
   added.
   Options `cmd' and `repo' are always ignored.
-- All arguments for all pseudo-protocols except |aurum://copy| are assumed to 
-  be escaped in the following fashion:
+- All arguments for all pseudo-protocols are assumed to be escaped in the 
+  following fashion:
                  Char  Esc ~
                     %  %%
                     ,  %c
 
     Note These mappings are defined for aurumcommit filetype.
 
-aurum://copy:{file}                                             *aurum://copy*
-    Like opening {file} read-only, but safer as you can't write opened file.
-
 aurum://diff:{repo}:{rev1}:{rev2}:{files}:{diffopts}            *aurum://diff*
     Open differencies between revisions {rev1} and {rev2} of files {files} 
     (semicolon-delimited list, semicolons in filenames can be escaped). For 
     {diffopts} see |aurum-diffoptions|. If one of {rev1} or {rev2} is empty 
-    then it will open the same diff as |:AuDiff| would if `rev1' or `rev2' 
-    options were not given (and `changes' option was not also). If {files} is 
-    empty, then it will show all changes.
+    then it will open the same diff as |:AuDiff| would if `rev1', `rev2' and 
+    `changes' options were not given. If {files} is empty, then it will show 
+    all changes.
     Local mappings (mgid=AuDiff, without leader by default):
                                                           *g:frawormap_AuDiff*
                          *g:frawormap_AuDiff_Next* *g:frawormap_AuDiff_Prev*