X-Git-Url: https://oss.titaniummirror.com/gitweb?a=blobdiff_plain;f=doc%2Fmkbuild.txt;h=c29f7115c117cec30906d2fc6d3c41476a71f468;hb=88c0758ecb26cafc1a243531059fabf26c790639;hp=4f658ffe5574ad4144becc2ca6f79e16d42dc2a4;hpb=e1ebb294da0c4950b5c2a23224cec7b3b1273e55;p=vim-mkbuild.git diff --git a/doc/mkbuild.txt b/doc/mkbuild.txt index 4f658ff..c29f711 100644 --- a/doc/mkbuild.txt +++ b/doc/mkbuild.txt @@ -8,8 +8,11 @@ This plugin is only available if 'compatible' is not set. INTRODUCTION *mkbuild* This plugin provides features for working with code using the mkbuild build -system. The only tool currently available is a method to select files from -the project using dmenu, which will also work without mkbuild. +system. + + +The first tool is a method to select files from the project using dmenu, which +will also work without mkbuild. Map mkbuild#DmenuOpen(cmd) to some key, such as: nnoremap e :call mkbuild#DmenuOpen('e') @@ -37,4 +40,13 @@ following priority order: 3. Perform a 'find . -type f' in the current directory. + +The second tool is a method to allow switching to a new tags and/or cscope +database. This is especially useful for mkbuild, which can build the same +code for multiple platforms, and each platform build directory contains its +own tags and cscope database files. + +Map mkbuild#SelectXref() to some key, such as: +nnoremap x :call mkbuild#SelectXref() + vim:tw=78:ts=8:ft=help:norl: