diff --git a/README.mkd b/README.mkd index eeabf21..5dbfb05 100644 --- a/README.mkd +++ b/README.mkd @@ -78,6 +78,7 @@ You can customise: * Line highlights * Extra arguments for `git diff` * Whether or not vim-gitgutter is on initially (defaults to on) +* Whether or not signs are shown (defaults to yes) * Whether or not line highlighting is on initially (defaults to off) * Whether or not vim-gitgutter runs on `BufEnter` (defaults to yes) * Whether or not vim-gitgutter runs for all buffers on `FocusGained` (defaults to yes) @@ -124,6 +125,14 @@ let g:gitgutter_sign_removed = 'zz' let g:gitgutter_sign_modified_removed = 'ww' ``` +#### Whether or not signs are shown + +If you never want signs to be shown (presumably you only want the line highlights), add this to your `~/.vimrc`: + +```viml +let g:gitgutter_signs = 0 +``` + #### Line highlights Similarly to the signs' colours, set up the following highlight groups in your colorscheme or `~/.vimrc`: diff --git a/doc/gitgutter.txt b/doc/gitgutter.txt index 26ac6ef..b787526 100644 --- a/doc/gitgutter.txt +++ b/doc/gitgutter.txt @@ -96,6 +96,7 @@ You can customise: - Line highlights - Extra arguments for git-diff - Whether or not vim-gitgutter is on initially (defaults to on) +- Whether or not signs are shown (defaults to yes) - Whether or not line highlighting is on initially (defaults to off) - Whether or not vim-gitgutter runs on `BufEnter` (defaults to yes) - Whether or not vim-gitgutter runs for all buffers on `FocusGained` (defaults @@ -155,6 +156,13 @@ To customise the symbols, add the following to your |vimrc|: let g:gitgutter_sign_modified_removed = 'ww' < +SIGNS + +To never show signs, use this: +> + let git:gitgutter_signs = 0 +< + LINE HIGHLIGHTS Similarly to the signs' colours, set up the following highlight groups in your diff --git a/plugin/gitgutter.vim b/plugin/gitgutter.vim index 9002294..3b1bfb0 100644 --- a/plugin/gitgutter.vim +++ b/plugin/gitgutter.vim @@ -16,6 +16,7 @@ function! s:set(var, default) endfunction call s:set('g:gitgutter_enabled', 1) +call s:set('g:gitgutter_signs', 1) call s:set('g:gitgutter_highlight_lines', 0) let s:highlight_lines = g:gitgutter_highlight_lines call s:set('g:gitgutter_sign_column_always', 0) @@ -155,8 +156,10 @@ function! s:define_signs() sign define GitGutterLineModifiedRemoved sign define GitGutterDummy - call s:define_sign_symbols() - call s:define_sign_text_highlights() + if g:gitgutter_signs + call s:define_sign_symbols() + call s:define_sign_text_highlights() + endif call s:define_sign_line_highlights() endfunction