[libvirt PATCH 00/10] docs: Convert hacking to rst, split and rework it

Daniel P. Berrangé berrange at redhat.com
Tue Apr 7 18:05:01 UTC 2020


On Mon, Apr 06, 2020 at 06:20:00PM +0200, Andrea Bolognani wrote:
> hacking.html is the canonical entry point for people looking to help
> with libvirt's development, but its sheer size makes it a farily
> ineffective tool.
> 
> Move most non-critical information off to separate pages and brush
> up what's left so that it works as a quick introduction.
> 
> As a prerequisite, convert the existing page to reStructuredText.
> 
> I have compared the HTML version and the conversion visually and
> didn't spot any massive differences, save for a few spacing changes
> that are not specific to the page itself but rather to the HTML
> generated by docutils and which will require CSS tweaks to address,
> which is a job I'm leaving to someone else.
> 
> I have also spent very little time actually changing the contents,
> and mostly just moved them around. There's plenty of opportunities
> for improvement there, but once again that's someone else's job.
> 
> Andrea Bolognani (10):
>   docs: Convert hacking.html to reStructuredText
>   docs: Add glib-adoption.rst
>   docs: Add coding-style.rst
>   docs: Add programming-languages.rst
>   docs: Add developer-tooling.rst
>   docs: Add committer-guidelines.rst
>   docs: Add advanced-tests.rst
>   docs: Add submitting-patches.rst
>   docs: Add best-practices.rst
>   docs: Update hacking.rst

Reviewed-by: Daniel P. Berrangé <berrange at redhat.com>

but note a comment on patch 1

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 :|




More information about the libvir-list mailing list