[libvirt] [PATCH 3/2] HACKING: Document developer tooling

Andrea Bolognani posted 2 patches 8 years, 9 months ago
[libvirt] [PATCH 3/2] HACKING: Document developer tooling
Posted by Andrea Bolognani 8 years, 9 months ago
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-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 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>,
+        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

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 3/2] HACKING: Document developer tooling
Posted by Daniel P. Berrange 8 years, 9 months ago
On Fri, Apr 28, 2017 at 06:33:49PM +0200, Andrea Bolognani wrote:
> 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(+)

ACK


Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 3/2] HACKING: Document developer tooling
Posted by Andrea Bolognani 8 years, 9 months ago
On Tue, 2017-05-02 at 09:06 +0100, Daniel P. Berrange wrote:
> > 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(+)
> 
> ACK

Can I consider this an ACK for the entire series, since it
wouldn't make sense to advertise support for those plugins
without actually implementing it? :)

-- 
Andrea Bolognani / Red Hat / Virtualization

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list
Re: [libvirt] [PATCH 3/2] HACKING: Document developer tooling
Posted by Daniel P. Berrange 8 years, 9 months ago
On Tue, May 02, 2017 at 11:57:02AM +0200, Andrea Bolognani wrote:
> On Tue, 2017-05-02 at 09:06 +0100, Daniel P. Berrange wrote:
> > > 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(+)
> > 
> > ACK
> 
> Can I consider this an ACK for the entire series, since it
> wouldn't make sense to advertise support for those plugins
> without actually implementing it? :)

Opps, yes, I forgot I didn't actually ack the previous patches last week :)

Regards,
Daniel
-- 
|: https://berrange.com      -o-    https://www.flickr.com/photos/dberrange :|
|: https://libvirt.org         -o-            https://fstop138.berrange.com :|
|: https://entangle-photo.org    -o-    https://www.instagram.com/dberrange :|

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list