[libvirt PATCH 4/5] news: Convert to reStructuredText

Ján Tomko jtomko at redhat.com
Wed Jun 3 12:41:02 UTC 2020


On a Tuesday in 2020, Andrea Bolognani wrote:
>Instead of storing release notes as XML and then converting them
>to HTML and ASCII at build time using XSLT and a custom script,
>we can use reStructuredText as both the source and ASCII
>representation and generate HTML from it using the same tooling
>we already use for the rest of the documentation.
>
>Signed-off-by: Andrea Bolognani <abologna at redhat.com>
>---
> Makefile.am              |   22 +-
> NEWS.rst                 | 3362 +++++++++++++++++++++++
> docs/Makefile.am         |   27 +-
> docs/libvirt.css         |   15 -
> docs/news-ascii.xsl      |   95 -
> docs/news-html.xsl       |  106 -
> docs/news.rng            |   72 -
> docs/news.xml            | 5473 --------------------------------------
> scripts/reformat-news.py |  102 -
> tests/virschematest.c    |    2 -
> 10 files changed, 3374 insertions(+), 5902 deletions(-)
> create mode 100644 NEWS.rst
> delete mode 100644 docs/news-ascii.xsl
> delete mode 100644 docs/news-html.xsl
> delete mode 100644 docs/news.rng
> delete mode 100644 docs/news.xml
> delete mode 100755 scripts/reformat-news.py
>
>diff --git a/Makefile.am b/Makefile.am
>index d56deeb080..3b93170bc6 100644
>--- a/Makefile.am
>+++ b/Makefile.am
>@@ -46,6 +46,7 @@ EXTRA_DIST = \
>   README.rst \
>   AUTHORS.in \
>   CONTRIBUTING.rst \
>+  NEWS.rst \
>   scripts/apibuild.py \
>   scripts/augeas-gentest.py \
>   build-aux/check-spacing.pl \
>@@ -69,7 +70,6 @@ EXTRA_DIST = \
>   scripts/minimize-po.py \
>   scripts/mock-noinline.py \
>   scripts/prohibit-duplicate-header.py \
>-  scripts/reformat-news.py \
>   scripts/test-wrap-argv.py \
>   build-aux/syntax-check.mk \
>   build-aux/useless-if-before-free \
>@@ -83,26 +83,6 @@ EXTRA_DIST = \
> pkgconfigdir = $(libdir)/pkgconfig
> pkgconfig_DATA = libvirt.pc libvirt-qemu.pc libvirt-lxc.pc libvirt-admin.pc
>
>-NEWS: \
>-	  $(srcdir)/docs/news.xml \
>-	  $(srcdir)/docs/news-ascii.xsl \
>-	  $(top_srcdir)/scripts/reformat-news.py
>-	$(AM_V_GEN) \
>-	if [ -x $(XSLTPROC) ]; then \
>-	  $(XSLTPROC) --nonet \
>-	    $(srcdir)/docs/news-ascii.xsl \
>-	    $(srcdir)/docs/news.xml \
>-	  >$@-tmp \
>-	    || { rm -f $@-tmp; exit 1; }; \
>-	  $(RUNUTF8) $(PYTHON) $(top_srcdir)/scripts/reformat-news.py $@-tmp >$@ \
>-	    || { rm -f $@-tmp; exit 1; }; \
>-	  rm -f $@-tmp; \
>-	fi
>-EXTRA_DIST += \
>-	$(srcdir)/docs/news.xml \
>-	$(srcdir)/docs/news-ascii.xsl \
>-	$(NULL)
>-
> rpm: clean
> 	@(unset CDPATH ; $(MAKE) dist && rpmbuild -ta $(distdir).tar.xz)
>
>diff --git a/NEWS.rst b/NEWS.rst
>new file mode 100644
>index 0000000000..128b899b88
>--- /dev/null
>+++ b/NEWS.rst
>@@ -0,0 +1,3362 @@
>+================
>+libvirt releases
>+================
>+
>+This is the list of official releases for libvirt, along with an overview of
>+the changes introduced by each of them.
>+
>+For a more fine-grained view, use the `git log`_.
>+
>+
>+v6.5.0 (unreleased)
>+===================
>+
>+* **New features**
>+
>+* **Improvements**
>+
>+* **Bug fixes**
>+
>+
>+v6.4.0 (2020-06-02)
>+===================
>+
>+* **New features**
>+
>+  - qemu: Add support for pvscsi controllers

You can use an asterisk for the nested bullet list as well, there's no
need to mix them up.

Jano
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 488 bytes
Desc: not available
URL: <http://listman.redhat.com/archives/libvir-list/attachments/20200603/765dad35/attachment-0001.sig>


More information about the libvir-list mailing list