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

Andrea Bolognani abologna at redhat.com
Mon Apr 6 16:20:00 UTC 2020

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

 build-aux/syntax-check.mk      |    4 +-
 docs/advanced-tests.rst        |  178 ++++
 docs/best-practices.rst        |   37 +
 docs/coding-style.rst          |  919 +++++++++++++++++++
 docs/committer-guidelines.rst  |   33 +
 docs/developer-tooling.rst     |   13 +
 docs/glib-adoption.rst         |   96 ++
 docs/hacking.html.in           | 1555 --------------------------------
 docs/hacking.rst               |   79 ++
 docs/programming-languages.rst |   21 +
 docs/submitting-patches.rst    |   88 ++
 11 files changed, 1466 insertions(+), 1557 deletions(-)
 create mode 100644 docs/advanced-tests.rst
 create mode 100644 docs/best-practices.rst
 create mode 100644 docs/coding-style.rst
 create mode 100644 docs/committer-guidelines.rst
 create mode 100644 docs/developer-tooling.rst
 create mode 100644 docs/glib-adoption.rst
 delete mode 100644 docs/hacking.html.in
 create mode 100644 docs/hacking.rst
 create mode 100644 docs/programming-languages.rst
 create mode 100644 docs/submitting-patches.rst


More information about the libvir-list mailing list