mirror of
https://github.com/SpaceVim/SpaceVim.git
synced 2025-01-24 06:20:05 +08:00
86 lines
3.6 KiB
Plaintext
Vendored
86 lines
3.6 KiB
Plaintext
Vendored
*cscope.vim.txt* A smart cscope helper for vim
|
|
Shidong Wang *cscope.vim*
|
|
|
|
==============================================================================
|
|
CONTENTS *cscope.vim-contents*
|
|
1. Introduction...........................................|cscope.vim-intro|
|
|
2. Commands............................................|cscope.vim-commands|
|
|
3. KEY MAPPINGS....................................|cscope.vim-key-mappings|
|
|
4. FAQ......................................................|cscope.vim-faq|
|
|
|
|
==============================================================================
|
|
INTRODUCTION *cscope.vim-intro*
|
|
|
|
cscope.vim is a smart cscope plugin for SpaceVim.
|
|
|
|
It will try to find a proper cscope database for current file, then connect to
|
|
it. If there is no proper cscope database for current file, you are prompted
|
|
to specify a folder with a string like --
|
|
|
|
Can not find proper cscope db, please input a path to create cscope db
|
|
for.
|
|
|
|
Then the plugin will create cscope database for you, connect to it, and find
|
|
what you want. The found result will be listed in a location list window. Next
|
|
time when you open the same file or other file that the cscope database can be
|
|
used for, the plugin will connect to the cscope database automatically. You
|
|
need not take care of anything about cscope database.
|
|
|
|
When you have a file edited/added in those folders for which cscope databases
|
|
have been created, cscove will automatically update the corresponding
|
|
database.
|
|
|
|
Cscove frees you from creating/connecting/updating cscope database, let you
|
|
focus on code browsing.
|
|
|
|
==============================================================================
|
|
COMMANDS *cscope.vim-commands*
|
|
|
|
:CscopeClear *:CscopeClear*
|
|
Clear cscope databases.
|
|
|
|
:CscopeList *:CscopeList*
|
|
List all the cscope databases.
|
|
|
|
==============================================================================
|
|
KEY MAPPINGS *cscope.vim-key-mappings*
|
|
|
|
The default key mappings has been removed from the plugin itself, since users
|
|
may prefer different choices.
|
|
|
|
So to use the plugin, you must define your own key mappings first.
|
|
|
|
Below is the minimum key mappings.
|
|
>
|
|
nnoremap <leader>fa :call cscope#findInteractive(expand('<cword>'))<CR>
|
|
nnoremap <leader>l :call cscope#toggleLocationList()<CR>
|
|
<
|
|
|
|
Some optional key mappings to search directly.
|
|
>
|
|
s: Find this C symbol
|
|
nnoremap <leader>fs :call cscope#find('s', expand('<cword>'))<CR>
|
|
" g: Find this definition
|
|
nnoremap <leader>fg :call cscope#find('g', expand('<cword>'))<CR>
|
|
" d: Find functions called by this function
|
|
nnoremap <leader>fd :call cscope#find('d', expand('<cword>'))<CR>
|
|
" c: Find functions calling this function
|
|
nnoremap <leader>fc :call cscope#find('c', expand('<cword>'))<CR>
|
|
" t: Find this text string
|
|
nnoremap <leader>ft :call cscope#find('t', expand('<cword>'))<CR>
|
|
" e: Find this egrep pattern
|
|
nnoremap <leader>fe :call cscope#find('e', expand('<cword>'))<CR>
|
|
" f: Find this file
|
|
nnoremap <leader>ff :call cscope#find('f', expand('<cword>'))<CR>
|
|
" i: Find files #including this file
|
|
nnoremap <leader>fi :call cscope#find('i', expand('<cword>'))<CR>
|
|
<
|
|
|
|
==============================================================================
|
|
FAQ *cscope.vim-faq*
|
|
|
|
This is a section of all the faq about this plugin.
|
|
|
|
|
|
vim:tw=78:ts=8:ft=help:norl:
|