docs

tomtom · Nov 15, 2010 · 78372e7 · 78372e7
1 parent 7b92b57
commit 78372e7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 11 deletions.
diff --git a/autoload/quickfixsigns.vim b/autoload/quickfixsigns.vim
@@ -3,8 +3,8 @@
 " @Website:     http://www.vim.org/account/profile.php?user_id=4037
 " @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 " @Created:     2010-03-19.
-" @Last Change: 2010-10-02.
-" @Revision:    0.0.34
+" @Last Change: 2010-11-13.
+" @Revision:    0.0.35
 
 
 if !exists('g:quickfixsigns#use_relativenumber')
@@ -31,6 +31,7 @@ endf
 
 
 " Display relative line numbers. Remove the signs when the cursor moves.
+" From vim 7.3 on, this uses the 'relativenumber' option.
 function! quickfixsigns#RelNumbersOnce() "{{{3
     if !has_key(g:quickfixsigns_lists, 'rel2')
         if v:version >= 703 && g:quickfixsigns#use_relativenumber

diff --git a/doc/quickfixsigns.txt b/doc/quickfixsigns.txt
@@ -115,18 +115,23 @@ g:quickfixsigns_events         (default: ['BufEnter', 'CursorHold', 'CursorHoldI
                                                     *g:quickfixsigns_class_rel*
 g:quickfixsigns_class_rel      (default: {'sign': '*s:RelSign', 'get': 's:GetRelList("rel")', 'event': g:quickfixsigns_events, 'max': 9, 'level': 9})
     Signs for number of lines relative to the current line.
+    Since 7.3, vim provides the 'relativenumber' option that provides 
+    a similar functionality.
+    See also |quickfixsigns#RelNumbersOnce()|.
 
                                                     *g:quickfixsigns_class_qfl*
-g:quickfixsigns_class_qfl      (default: {'sign': 'QFS_QFL', 'get': 'getqflist()', 'event': ['BufEnter', 'CursorHold', 'CursorHoldI', 'QuickFixCmdPost'], 'all_buffers': 1})
+g:quickfixsigns_class_qfl      (default: {'sign': 'QFS_QFL', 'get': 'getqflist()', 'event': ['BufEnter', 'CursorHold', 'CursorHoldI', 'QuickFixCmdPost'], 'scope': 'vim'})
     Signs for |quickfix| lists.
 
                                                     *g:quickfixsigns_class_loc*
 g:quickfixsigns_class_loc      (default: {'sign': 'QFS_LOC', 'get': 'getloclist(0)', 'event': ['BufEnter', 'CursorHold', 'CursorHoldI']})
     Signs for |location| lists.
 
                                                     *g:quickfixsigns_class_cursor*
-g:quickfixsigns_class_cursor   (default: {'sign': 'QFS_CURSOR', 'get': 's:GetCursor()', 'event': ['BufEnter', 'CursorHold', 'CursorHoldI']})
-    Sign for the current cursor position
+g:quickfixsigns_class_cursor   (default: {'sign': 'QFS_CURSOR', 'get': 's:GetCursor()', 'event': g:quickfixsigns_events})
+    Sign for the current cursor position. The cursor position is 
+    lazily updated. If you want something more precise, consider 
+    setting 'cursorline'.
 
                                                     *g:quickfixsigns_balloon*
 g:quickfixsigns_balloon        (default: 1)
@@ -135,7 +140,7 @@ g:quickfixsigns_balloon        (default: 1)
     buffer-local or global
 
                                                     *g:quickfixsigns_max*
-g:quickfixsigns_max            (default: 100)
+g:quickfixsigns_max            (default: 500)
     Don't display signs if the list is longer than n items.
 
                                                     *g:quickfixsigns_blacklist_buffer*
@@ -185,6 +190,7 @@ quickfixsigns#CompleteSelect(ArgLead, CmdLine, CursorPos)
                                                     *quickfixsigns#RelNumbersOnce()*
 quickfixsigns#RelNumbersOnce()
     Display relative line numbers. Remove the signs when the cursor moves.
+    From vim 7.3 on, this uses the 'relativenumber' option.
 
 
 ========================================================================

diff --git a/plugin/quickfixsigns.vim b/plugin/quickfixsigns.vim
@@ -4,14 +4,14 @@
 " @GIT:         http://github.com/tomtom/quickfixsigns_vim/
 " @License:     GPL (see http://www.gnu.org/licenses/gpl.txt)
 " @Created:     2009-03-14.
-" @Last Change: 2010-11-13.
-" @Revision:    681
+" @Last Change: 2010-11-15.
+" @Revision:    686
 " GetLatestVimScripts: 2584 1 :AutoInstall: quickfixsigns.vim
 
 if &cp || exists("loaded_quickfixsigns") || !has('signs')
     finish
 endif
-let loaded_quickfixsigns = 10
+let loaded_quickfixsigns = 11
 
 let s:save_cpo = &cpo
 set cpo&vim
@@ -61,6 +61,9 @@ endif
 
 if !exists('g:quickfixsigns_class_rel')
     " Signs for number of lines relative to the current line.
+    " Since 7.3, vim provides the 'relativenumber' option that provides 
+    " a similar functionality.
+    " See also |quickfixsigns#RelNumbersOnce()|.
     let g:quickfixsigns_class_rel = {'sign': '*s:RelSign', 'get': 's:GetRelList("rel")', 'event': g:quickfixsigns_events, 'max': 9, 'level': 9}  "{{{2
 endif
 let g:quickfixsigns_class_rel2 = copy(g:quickfixsigns_class_rel)
@@ -81,8 +84,10 @@ endif
 
 
 if !exists('g:quickfixsigns_class_cursor')
-    " Sign for the current cursor position
-    let g:quickfixsigns_class_cursor = {'sign': 'QFS_CURSOR', 'get': 's:GetCursor()', 'event': ['BufEnter', 'CursorHold', 'CursorHoldI']}   "{{{2
+    " Sign for the current cursor position. The cursor position is 
+    " lazily updated. If you want something more precise, consider 
+    " setting 'cursorline'.
+    let g:quickfixsigns_class_cursor = {'sign': 'QFS_CURSOR', 'get': 's:GetCursor()', 'event': g:quickfixsigns_events}   "{{{2
 endif