Convert documentation to reStructuredText, other cleanups

[libvirt-dbus PATCH 0/9] Convert documentation to reStructuredText, other cleanups

Posted by Andrea Bolognani 4 years ago

I think it's high time that we have a new libvirt-dbus release, since
the last one was more than a year ago: since then, there has been at
least one bug fix necessary to keep it building on modern platforms,
an additional API has been implemented, and of course we've switched
the build system from autotools to Meson.

I validated the status of what's in master by importing a snapshot
into the Debian package and everything seems to be in order, so I'm
fairly confident we could basically just tag a release right away;
there are, however, a few straightforward improvements that I would
like to get into the new release, so here we are :)

Andrea Bolognani (9):
  git: Minimize ignore patterns
  spec: Install fewer documentation files
  README: Convert to reStructuredText
  HACKING: Convert to reStructuredText
  NEWS: Convert to reStructuredText
  AUTHORS: Convert to reStructuredText
  man: Convert to reStructuredText
  meson: Install documentation
  spec: Pick documentation from installation directory

 .gitignore              |  47 ---------
 AUTHORS.in              |  16 ----
 AUTHORS.rst.in          |  17 ++++
 HACKING.md              | 205 ---------------------------------------
 HACKING.rst             | 207 ++++++++++++++++++++++++++++++++++++++++
 NEWS                    |  88 -----------------
 NEWS.rst                |  94 ++++++++++++++++++
 README.md => README.rst |  37 +++----
 docs/libvirt-dbus.pod   |  66 -------------
 docs/libvirt-dbus.rst   |  71 ++++++++++++++
 docs/meson.build        |   6 +-
 libvirt-dbus.spec.in    |   7 +-
 meson.build             |  24 ++++-
 tools/gen-authors.sh    |   2 +-
 14 files changed, 437 insertions(+), 450 deletions(-)
 delete mode 100644 AUTHORS.in
 create mode 100644 AUTHORS.rst.in
 delete mode 100644 HACKING.md
 create mode 100644 HACKING.rst
 delete mode 100644 NEWS
 create mode 100644 NEWS.rst
 rename README.md => README.rst (68%)
 delete mode 100644 docs/libvirt-dbus.pod
 create mode 100644 docs/libvirt-dbus.rst

-- 
2.25.3

Re: [libvirt-dbus PATCH 0/9] Convert documentation to reStructuredText, other cleanups

Posted by Pavel Hrdina 3 years, 12 months ago

On Sat, Apr 25, 2020 at 10:59:37PM +0200, Andrea Bolognani wrote:
> I think it's high time that we have a new libvirt-dbus release, since
> the last one was more than a year ago: since then, there has been at
> least one bug fix necessary to keep it building on modern platforms,
> an additional API has been implemented, and of course we've switched
> the build system from autotools to Meson.
> 
> I validated the status of what's in master by importing a snapshot
> into the Debian package and everything seems to be in order, so I'm
> fairly confident we could basically just tag a release right away;
> there are, however, a few straightforward improvements that I would
> like to get into the new release, so here we are :)
> 
> Andrea Bolognani (9):
>   git: Minimize ignore patterns
>   spec: Install fewer documentation files
>   README: Convert to reStructuredText
>   HACKING: Convert to reStructuredText
>   NEWS: Convert to reStructuredText
>   AUTHORS: Convert to reStructuredText
>   man: Convert to reStructuredText
>   meson: Install documentation
>   spec: Pick documentation from installation directory

With the issues in last two patches fixed

Reviewed-by: Pavel Hrdina <phrdina@redhat.com>

Re: [libvirt-dbus PATCH 0/9] Convert documentation to reStructuredText, other cleanups

Posted by Erik Skultety 3 years, 12 months ago

On Sat, Apr 25, 2020 at 10:59:37PM +0200, Andrea Bolognani wrote:
> I think it's high time that we have a new libvirt-dbus release, since
> the last one was more than a year ago: since then, there has been at
> least one bug fix necessary to keep it building on modern platforms,
> an additional API has been implemented, and of course we've switched
> the build system from autotools to Meson.
> 
> I validated the status of what's in master by importing a snapshot
> into the Debian package and everything seems to be in order, so I'm
> fairly confident we could basically just tag a release right away;
> there are, however, a few straightforward improvements that I would
> like to get into the new release, so here we are :)

Apart from patch 8/9 which I can't review confidently, the rest looks good,
provided you've tested this thoroughly, for the whole series:

Reviewed-by: Erik Skultety <eskultet@redhat.com>

Re: [libvirt-dbus PATCH 0/9] Convert documentation to reStructuredText, other cleanups

Posted by Andrea Bolognani 3 years, 12 months ago

On Mon, 2020-04-27 at 10:17 +0200, Erik Skultety wrote:
> On Sat, Apr 25, 2020 at 10:59:37PM +0200, Andrea Bolognani wrote:
> > I think it's high time that we have a new libvirt-dbus release, since
> > the last one was more than a year ago: since then, there has been at
> > least one bug fix necessary to keep it building on modern platforms,
> > an additional API has been implemented, and of course we've switched
> > the build system from autotools to Meson.
> > 
> > I validated the status of what's in master by importing a snapshot
> > into the Debian package and everything seems to be in order, so I'm
> > fairly confident we could basically just tag a release right away;
> > there are, however, a few straightforward improvements that I would
> > like to get into the new release, so here we are :)
> 
> Apart from patch 8/9 which I can't review confidently, the rest looks good,
> provided you've tested this thoroughly, for the whole series:
> 
> Reviewed-by: Erik Skultety <eskultet@redhat.com>

Thanks! Pavel promised he'd look at this series, and consider making
a new release, soon :)

-- 
Andrea Bolognani / Red Hat / Virtualization