YouCompleteMe[1] is a vim plugin that implements semantic code completion using libclang. For non-trivial projects such as libvirt, the plugin needs some help figuring out where to find the various header files: generate its configuration file at configure time so that the plugin works out of the box. [1] http://valloric.github.io/YouCompleteMe/ --- .gitignore | 1 + .ycm_extra_conf.py.in | 45 +++++++++++++++++++++++++++++++++++++++++++++ configure.ac | 1 + 3 files changed, 47 insertions(+) create mode 100644 .ycm_extra_conf.py.in diff --git a/.gitignore b/.gitignore index e690c99..e2eaff1 100644 --- a/.gitignore +++ b/.gitignore @@ -36,6 +36,7 @@ .lvimrc .memdump .sc-start-sc_* +.ycm_extra_conf.py /ABOUT-NLS /AUTHORS /ChangeLog diff --git a/.ycm_extra_conf.py.in b/.ycm_extra_conf.py.in new file mode 100644 index 0000000..96c8a47 --- /dev/null +++ b/.ycm_extra_conf.py.in @@ -0,0 +1,45 @@ +flags = [ + '-I@abs_top_builddir@', + '-I@abs_top_srcdir@', + '-I@abs_top_builddir@/gnulib/lib', + '-I@abs_top_srcdir@/gnulib/lib', + '-I@abs_top_builddir@/include', + '-I@abs_top_srcdir@/include', + '-I@abs_top_builddir@/src', + '-I@abs_top_srcdir@/src', + '-I@abs_top_builddir@/src/access', + '-I@abs_top_srcdir@/src/access', + '-I@abs_top_builddir@/src/admin', + '-I@abs_top_srcdir@/src/admin', + '-I@abs_top_builddir@/src/bhyve', + '-I@abs_top_srcdir@/src/bhyve', + '-I@abs_top_builddir@/src/conf', + '-I@abs_top_srcdir@/src/conf', + '-I@abs_top_builddir@/src/libxl', + '-I@abs_top_srcdir@/src/libxl', + '-I@abs_top_builddir@/src/locking', + '-I@abs_top_srcdir@/src/locking', + '-I@abs_top_builddir@/src/logging', + '-I@abs_top_srcdir@/src/logging', + '-I@abs_top_builddir@/src/lxc', + '-I@abs_top_srcdir@/src/lxc', + '-I@abs_top_builddir@/src/qemu', + '-I@abs_top_srcdir@/src/qemu', + '-I@abs_top_builddir@/src/remote', + '-I@abs_top_srcdir@/src/remote', + '-I@abs_top_builddir@/src/rpc', + '-I@abs_top_srcdir@/src/rpc', + '-I@abs_top_builddir@/src/secret', + '-I@abs_top_srcdir@/src/secret', + '-I@abs_top_builddir@/src/security', + '-I@abs_top_srcdir@/src/security', + '-I@abs_top_builddir@/src/util', + '-I@abs_top_srcdir@/src/util', + '-I@abs_top_builddir@/src/vmx', + '-I@abs_top_srcdir@/src/vmx', + '-I@abs_top_builddir@/src/xenconfig', + '-I@abs_top_srcdir@/src/xenconfig', +] + +def FlagsForFile(filename, **kwargs): + return { 'flags': flags, 'do_cache': True } diff --git a/configure.ac b/configure.ac index 752d787..fa63406 100644 --- a/configure.ac +++ b/configure.ac @@ -880,6 +880,7 @@ AC_CONFIG_FILES([\ gnulib/lib/Makefile \ gnulib/tests/Makefile \ .color_coded \ + .ycm_extra_conf.py \ libvirt.pc \ libvirt-qemu.pc \ libvirt-lxc.pc \ -- 2.7.4

Advertise some of the useful developer tooling libvirt integrates with out of the box. --- HACKING | 13 +++++++++++++ docs/hacking.html.in | 20 ++++++++++++++++++++ 2 files changed, 33 insertions(+) diff --git a/HACKING b/HACKING index 74d1068..b78a9ae 100644 --- a/HACKING +++ b/HACKING @@ -239,6 +239,19 @@ on the subject, on Richard Jones' guide to working with open source projects <http://people.redhat.com/rjones/how-to-supply-code-to-open-source-project...;. +Tooling +======= +libvirt includes support for some useful development tools right in its source +repository, meaning users will be able to take advantage of them without +little or no configuration. Examples include: + +- color_coded <https://github.com/jeaye/color_coded>;, a vim plugin for +libclang-powered semantic syntax highlighting; + +- YouCompleteMe <http://valloric.github.io/YouCompleteMe/>;, a vim plugin for +libclang-powered semantic code completion. + + Naming conventions ================== When reading libvirt code, a number of different naming conventions will be diff --git a/docs/hacking.html.in b/docs/hacking.html.in index 2bc12ea..d6a574c 100644 --- a/docs/hacking.html.in +++ b/docs/hacking.html.in @@ -314,6 +314,26 @@ Richard Jones' guide to working with open source projects</a>. </p> + <h2><a name="tooling">Tooling</a></h2> + + <p> + libvirt includes support for some useful development tools right in its + source repository, meaning users will be able to take advantage of them + without little or no configuration. Examples include: + </p> + + <ul> + <li> + <a href="https://github.com/jeaye/color_coded">color_coded</...;, + a vim plugin for libclang-powered semantic syntax highlighting; + </li> + + <li> + <a href="http://valloric.github.io/YouCompleteMe/">YouCompleteMe</a>, + a vim plugin for libclang-powered semantic code completion. + </li> + </ul> + <h2><a name="naming">Naming conventions</a></h2> <p> -- 2.7.4