HACKING: Document developer tooling

Advertise some of the useful developer tooling libvirt
integrates with out of the box.

diff --git a/HACKING b/HACKING
index 74d10686edf7db9e4784a2732beac048b81ea7d8..b78a9aee6432bebd46e662ed9fe0672831df725c 100644 (file)
--- 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-projects/>.
 
 
+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 2bc12ea78c88e0cc8fe5eee02d14492c105c6503..d6a574c4abbe8695abd5c3780b04307c6c85908a 100644 (file)
--- 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>,
+        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>