improve docs, remove deprecation warnings

This commit is contained in:
Bailey Ling 2013-08-14 02:32:05 +00:00
parent 5b840ae436
commit 10e8146d7b
2 changed files with 42 additions and 79 deletions

View File

@ -37,94 +37,52 @@ CONFIGURATION *airline-configuration*
There are a couple configuration values available (shown with their default There are a couple configuration values available (shown with their default
values): values):
* the separator used on the left side * the separator used on the left side >
>
let g:airline_left_sep='>' let g:airline_left_sep='>'
< <
* the separator used on the right side >
* the separator used on the right side
>
let g:airline_right_sep='<' let g:airline_right_sep='<'
< <
* enable modified detection >
* enable/disable fugitive/lawrencium integration
>
let g:airline_enable_branch=1
let g:airline_branch_empty_message=''
<
* enable/disable syntastic integration
>
let g:airline_enable_syntastic=1
<
* enable/disable tagbar integration
>
let g:airline_enable_tagbar=1
<
* enable modified detection
>
let g:airline_detect_modified=1 let g:airline_detect_modified=1
<
* enable paste detection * enable paste detection >
>
let g:airline_detect_paste=1 let g:airline_detect_paste=1
< <
* enable iminsert detection >
* enable iminsert detection
>
let g:airline_detect_iminsert=1 let g:airline_detect_iminsert=1
< <
* enable whitespace detection >
* enable whitespace detection
>
let g:airline_detect_whitespace=0 "disabled let g:airline_detect_whitespace=0 "disabled
let g:airline_detect_whitespace=1 "icon and message (default) let g:airline_detect_whitespace=1 "icon and message (default)
let g:airline_detect_whitespace=2 "icon only let g:airline_detect_whitespace=2 "icon only
< <
* determine whether inactive windows should have the left section collapsed to * determine whether inactive windows should have the left section collapsed to
only the filename of that buffer. only the filename of that buffer. >
>
let g:airline_inactive_collapse=1 let g:airline_inactive_collapse=1
< <
* change the default theme >
* change the default theme
>
let g:airline_theme='dark' let g:airline_theme='dark'
< <
* enable/disable usage of patched powerline font symbols >
* enable/disable usage of patched powerline font symbols
>
let g:airline_powerline_fonts=0 let g:airline_powerline_fonts=0
< <
* define the set of text to display for each mode. >
* define the set of text to display for each mode.
>
let g:airline_mode_map = {} " see source for current list let g:airline_mode_map = {} " see source for current list
< <
* define the set of filename match queries which excludes a window from having * define the set of filename match queries which excludes a window from having
its statusline modified its statusline modified >
>
let g:airline_exclude_filenames = [] " see source for current list let g:airline_exclude_filenames = [] " see source for current list
< <
* define the set of filetypes which are excluded from having its window * define the set of filetypes which are excluded from having its window
statusline modified statusline modified >
>
let g:airline_exclude_filetypes = [] " see source for current list let g:airline_exclude_filetypes = [] " see source for current list
< <
* defines whether the preview window should be excluded from have its window * defines whether the preview window should be excluded from have its window
statusline modified (may help with plugins which use the preview window statusline modified (may help with plugins which use the preview window
heavily) heavily) >
>
let g:airline_exclude_preview = 0 let g:airline_exclude_preview = 0
< <
============================================================================== ==============================================================================
COMMANDS *airline-commands* COMMANDS *airline-commands*
@ -194,19 +152,38 @@ sections which by default host more than one extension.
let g:airline_section_b = '%{getcwd()}' let g:airline_section_b = '%{getcwd()}'
let g:airline_section_c = '%t' let g:airline_section_c = '%t'
< <
============================================================================== ==============================================================================
EXTENSIONS *airline-extensions* EXTENSIONS *airline-extensions*
*airline-branch*
fugitive.vim <https://github.com/tpope/vim-fugitive>
lawrencium <https://bitbucket.org/ludovicchabant/vim-lawrencium>
* enable/disable fugitive/lawrencium integration >
let g:airline_enable_branch = 1
<
* change the text for when no branch is detected >
let g:airline_branch_empty_message = ''
<
*airline-syntastic*
syntastic <https://github.com/scrooloose/syntastic>
* enable/disable syntastic integration >
let g:airline_enable_syntastic = 1
<
*airline-tagbar*
tagbar <https://github.com/majutsushi/>
* enable/disable tagbar integration >
let g:airline_enable_tagbar = 1
<
*airline-csv* *airline-csv*
csv.vim <https://github.com/chrisbra/csv.vim> csv.vim <https://github.com/chrisbra/csv.vim>
* enable/disable csv integration for displaying the current column number. * enable/disable csv integration for displaying the current column number. >
>
let g:airline_enable_csv = 1 let g:airline_enable_csv = 1
> >
* change how columns are identified. * change how columns are identified. >
>
let g:airline#extensions#csv#column_identify = '' (default) let g:airline#extensions#csv#column_identify = '' (default)
let g:airline#extensions#csv#column_identify = 'Name' (extracts column name) let g:airline#extensions#csv#column_identify = 'Name' (extracts column name)
> >
@ -262,31 +239,23 @@ Q. There are no colors.
A. You need to set up your terminal correctly. For more details, see A. You need to set up your terminal correctly. For more details, see
<http://vim.wikia.com/wiki/256_colors_in_vim>. Alternatively, if you want <http://vim.wikia.com/wiki/256_colors_in_vim>. Alternatively, if you want
to bypass the automatic detection of terminal colors, you can force Vim to bypass the automatic detection of terminal colors, you can force Vim
into 256 color mode with this: into 256 color mode with this: >
>
set t_Co=256 set t_Co=256
< <
Q. The statusline does not appear until I create a split. Q. The statusline does not appear until I create a split.
A. This is the default setting of |laststatus|. If you want it to appear all A. This is the default setting of |laststatus|. If you want it to appear all
the time, add the following to your vimrc: the time, add the following to your vimrc: >
>
set laststatus=2 set laststatus=2
< <
Q. Powerline symbols are not showing up. Q. Powerline symbols are not showing up.
A. First, you must install patched powerline fonts. Second, you must enable A. First, you must install patched powerline fonts. Second, you must enable
unicode in vim. unicode in vim. >
>
set encoding=utf-8 set encoding=utf-8
< <
Q. There is a pause when leaving insert mode. Q. There is a pause when leaving insert mode.
A. Add the following to your vimrc. A. Add the following to your vimrc. >
>
set ttimeoutlen=50 set ttimeoutlen=50
< <
Q. The colors look a little off for some themes. Q. The colors look a little off for some themes.
A. Certain themes are derived from the active colorscheme by extracting colors A. Certain themes are derived from the active colorscheme by extracting colors
from predefined highlight groups. These airline themes will look good for from predefined highlight groups. These airline themes will look good for
@ -305,7 +274,7 @@ Contributions and pull requests are welcome.
============================================================================== ==============================================================================
LICENSE *airline-license* LICENSE *airline-license*
MIT license. Copyright © 2013 Bailey Ling. MIT License. Copyright © 2013 Bailey Ling.
vim:tw=78:ts=8:ft=help:norl: vim:tw=78:ts=8:ft=help:norl:

View File

@ -10,12 +10,6 @@ function! s:check_defined(variable, default)
let {a:variable} = a:default let {a:variable} = a:default
endif endif
endfunction endfunction
if exists('g:airline_enable_fugitive') || exists('g:airline_fugitive_prefix')
echom 'The g:airline_enable_fugitive and g:airline_fugitive_prefix variables have been deprecated and renamed to g:airline_enable_branch and g:airline_branch_prefix respectively. Please update your vimrc.'
endif
if exists('g:airline_window_override_funcrefs')
echom 'The g:airline_window_override_funcrefs variable has been deprecated. Please use g:airline_statusline_funcrefs instead.'
endif
call s:check_defined('g:airline_left_sep', exists('g:airline_powerline_fonts')?"":">") call s:check_defined('g:airline_left_sep', exists('g:airline_powerline_fonts')?"":">")
call s:check_defined('g:airline_left_alt_sep', exists('g:airline_powerline_fonts')?"":">") call s:check_defined('g:airline_left_alt_sep', exists('g:airline_powerline_fonts')?"":">")
call s:check_defined('g:airline_right_sep', exists('g:airline_powerline_fonts')?"":"<") call s:check_defined('g:airline_right_sep', exists('g:airline_powerline_fonts')?"":"<")