[libvirt PATCH] Convert all remaining Markdown files to reStructuredText

We've adopted reStructuredText as the primary markup language for our documentation and, given that both GitLab and GitHub can render documents in this format just fine, it makes sense to get rid of the few last remaining bits of Markdown and standardize on reStructuredText across the board. Signed-off-by: Andrea Bolognani <abologna(a)redhat.com&gt; --- Note that I've taken a few liberties during the conversion when it comes to formatting, with the goal of staying close to the style used for existing reStructuredText documents, but I have not altered the contents beyond that. ABOUT-NLS | 2 +- Makefile.am | 2 +- README | 2 +- README.md => README.rst | 55 ++++++++++++----------- docs/Makefile.am | 2 +- docs/fonts/{LICENSE.md => LICENSE.rst} | 30 +++++++++---- libvirt.spec.in | 2 +- po/{README.md => README.rst} | 32 ++++++++----- tools/wireshark/{README.md => README.rst} | 28 ++++++++---- 9 files changed, 97 insertions(+), 58 deletions(-) rename README.md => README.rst (65%) rename docs/fonts/{LICENSE.md => LICENSE.rst} (94%) rename po/{README.md => README.rst} (86%) rename tools/wireshark/{README.md => README.rst} (52%) diff --git a/ABOUT-NLS b/ABOUT-NLS index b583e276a7..91a3266ed6 120000 --- a/ABOUT-NLS +++ b/ABOUT-NLS @@ -1 +1 @@ -po/README.md \ No newline at end of file +po/README.rst \ No newline at end of file diff --git a/Makefile.am b/Makefile.am index 5590c88e4d..06475344c1 100644 --- a/Makefile.am +++ b/Makefile.am @@ -43,7 +43,7 @@ EXTRA_DIST = \ autogen.sh \ GNUmakefile \ run.in \ - README.md \ + README.rst \ AUTHORS.in \ scripts/apibuild.py \ scripts/augeas-gentest.py \ diff --git a/README b/README index 42061c01a1..92cacd2853 120000 --- a/README +++ b/README @@ -1 +1 @@ -README.md \ No newline at end of file +README.rst \ No newline at end of file diff --git a/README.md b/README.rst similarity index 65% rename from README.md rename to README.rst index 44b0dd87c5..663fba4510 100644 --- a/README.md +++ b/README.rst @@ -1,6 +1,9 @@ -[](https://travis-ci.org... - [ +https://libvirt.org License -------- +======= The libvirt C API is distributed under the terms of GNU Lesser General Public License, version 2.1 (or later). Some parts of the code that are not part of the C library may have the more restrictive GNU General -Public License, version 2.0 (or later). See the files `COPYING.LESSER` -and `COPYING` for full license terms & conditions. +Public License, version 2.0 (or later). See the files ``COPYING.LESSER`` +and ``COPYING`` for full license terms & conditions. Installation ------------- +============ Libvirt uses the GNU Autotools build system, so in general can be built and installed with the usual commands, however, we mandate to have the build directory different than the source directory. For example, to build in a manner that is suitable for installing as root, use: -``` -$ mkdir build && cd build -$ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var -$ make -$ sudo make install -``` +:: + + $ mkdir build && cd build + $ ../configure --prefix=/usr --sysconfdir=/etc --localstatedir=/var + $ make + $ sudo make install While to build & install as an unprivileged user -``` -$ mkdir build && cd build -$ ../configure --prefix=$HOME/usr -$ make -$ make install -``` +:: + + $ mkdir build && cd build + $ ../configure --prefix=$HOME/usr + $ make + $ make install The libvirt code relies on a large number of 3rd party libraries. These will -be detected during execution of the `configure` script and a summary printed +be detected during execution of the ``configure`` script and a summary printed which lists any missing (optional) dependencies. Contributing ------------- +============ The libvirt project welcomes contributions in many ways. For most components the best way to contribute is to send patches to the primary development mailing list. Further guidance on this can be found on the website: -[https://libvirt.org/contribute.html](https://libvirt.org/contribute.html) +https://libvirt.org/contribute.html Contact -------- +======= The libvirt project has two primary mailing lists: - * libvirt-users(a)redhat.com (**for user discussions**) - * libvir-list(a)redhat.com (**for development only**) +* libvirt-users(a)redhat.com (**for user discussions**) +* libvir-list(a)redhat.com (**for development only**) Further details on contacting the project are available on the website: -[https://libvirt.org/contact.html](https://libvirt.org/contact.html) +https://libvirt.org/contact.html diff --git a/docs/Makefile.am b/docs/Makefile.am index 404121a2a2..6860efc888 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -118,7 +118,7 @@ javascriptdir = $(HTML_DIR)/js javascript_DATA = $(javascript) fonts = \ - fonts/LICENSE.md \ + fonts/LICENSE.rst \ fonts/stylesheet.css \ fonts/overpass-bold-italic.woff \ fonts/overpass-bold.woff \ diff --git a/docs/fonts/LICENSE.md b/docs/fonts/LICENSE.rst similarity index 94% rename from docs/fonts/LICENSE.md rename to docs/fonts/LICENSE.rst index 9520f30f73..4e32b1a1d3 100644 --- a/docs/fonts/LICENSE.md +++ b/docs/fonts/LICENSE.rst @@ -1,18 +1,24 @@ -## License +======= +License +======= Copyright (C) 2015 Red Hat, Inc., This Font Software is licensed under the SIL Open Font License, Version 1.1. This license is copied below, and is also available with a FAQ at: + http://scripts.sil.org/OFL -#### SIL OPEN FONT LICENSE +===================== +SIL OPEN FONT LICENSE +===================== + Version 1.1 - 26 February 2007 ---- +PREAMBLE +======== -#### PREAMBLE The goals of the Open Font License (OFL) are to stimulate worldwide development of collaborative font projects, to support the font creation efforts of academic and linguistic communities, and to provide a free and open framework @@ -27,7 +33,9 @@ any other type of license. The requirement for fonts to remain under this license does not apply to any document created using the fonts or their derivatives. -#### DEFINITIONS +DEFINITIONS +=========== + “Font Software” refers to the set of files released by the Copyright Holder(s) under this license and clearly marked as such. This may include source files, build scripts and documentation. @@ -45,7 +53,9 @@ by changing formats or by porting the Font Software to a new environment. “Author” refers to any designer, engineer, programmer, technical writer or other person who contributed to the Font Software. -#### PERMISSION & CONDITIONS +PERMISSION & CONDITIONS +======================= + Permission is hereby granted, free of charge, to any person obtaining a copy of the Font Software, to use, study, copy, merge, embed, modify, redistribute, and sell modified and unmodified copies of the Font Software, subject to the @@ -76,10 +86,14 @@ distributed entirely under this license, and must not be distributed under any other license. The requirement for fonts to remain under this license does not apply to any document created using the Font Software. -#### TERMINATION +TERMINATION +=========== + This license becomes null and void if any of the above conditions are not met. -#### DISCLAIMER +DISCLAIMER +========== + THE FONT SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, diff --git a/libvirt.spec.in b/libvirt.spec.in index 6061a26497..6abf97df85 100644 --- a/libvirt.spec.in +++ b/libvirt.spec.in @@ -1505,7 +1505,7 @@ exit 0 %files %files docs -%doc AUTHORS ChangeLog NEWS README README.md +%doc AUTHORS ChangeLog NEWS README README.rst %doc %{_vpath_builddir}/libvirt-docs/* %files daemon diff --git a/po/README.md b/po/README.rst similarity index 86% rename from po/README.md rename to po/README.rst index 2f77c5d48c..2e234547ca 100644 --- a/po/README.md +++ b/po/README.rst @@ -1,3 +1,4 @@ +=========================== Libvirt Message Translation =========================== @@ -7,6 +8,7 @@ file formats, in combination with the Zanata web service. python-zanata-client is required in order to use make to pull/push translations from/to Zanata server. + Source repository ================= @@ -14,21 +16,25 @@ The libvirt GIT repository does NOT store the master "libvirt.pot" file, nor does it store full "po" files for translations. The master "libvirt.pot" file can be generated at any time using - make libvirt.pot +:: + + $ make libvirt.pot The translations are kept in minimized files that are the same file format as normal po files but with all redundant information stripped and messages re-ordered. The key differences between the ".mini.po" files in GIT and the full ".po" files are - - msgids with no current translation are omitted - - msgids are sorted in alphabetical order not source file order - - msgids with a msgstr marked "fuzzy" are discarded - - source file locations are omitted +* msgids with no current translation are omitted +* msgids are sorted in alphabetical order not source file order +* msgids with a msgstr marked "fuzzy" are discarded +* source file locations are omitted The full po files can be created at any time using - make update-po +:: + + $ make update-po This merges the "libvirt.pot" with the "$LANG.mini.po" for each language, to create the "$LANG.po" files. These are included in the release archives created @@ -37,7 +43,9 @@ by "make dist". When a full po file is updated, changes can be propagated back into the minimized po files using - make update-mini-po +:: + + $ make update-mini-po Note, however, that this is generally not something that should be run by developers normally, as it is triggered by 'make pull-po' when refreshing @@ -50,7 +58,7 @@ Zanata web service The translation of libvirt messages has been outsourced to the Fedora translation team using the Zanata web service: - https://fedora.zanata.org/project/view/libvirt +https://fedora.zanata.org/project/view/libvirt As such, changes to translations will generally NOT be accepted as patches directly to libvirt GIT. Any changes made to "$LANG.mini.po" files in libvirt @@ -59,12 +67,16 @@ GIT will be overwritten and lost the next time content is imported from Zanata. The master "libvirt.pot" file is periodically pushed to Zanata to provide the translation team with content changes, using - make push-pot +:: + + $ make push-pot New translated text is then periodically pulled down from Zanata to update the minimized po files, using - make pull-po +:: + + $ make pull-po Sometimes the translators make mistakes, most commonly with handling printf format specifiers. The "pull-po" command re-generates the .gmo files to try to diff --git a/tools/wireshark/README.md b/tools/wireshark/README.rst similarity index 52% rename from tools/wireshark/README.md rename to tools/wireshark/README.rst index b7f40d0954..919b89d32a 100644 --- a/tools/wireshark/README.md +++ b/tools/wireshark/README.rst @@ -1,5 +1,7 @@ +===== About ===== + This is the project of Google Summer of Code 2013 accepted by QEMU.org and libvirt community. The goal of this project is, provide Wireshark dissector for Libvirt RPC protocol. It will provide Libvirt packet overview/detail analysing @@ -8,24 +10,32 @@ definition placed in Libvirt source tree to support latest protocol specification. See also: -- http://www.google-melange.com/gsoc/project/google/gsoc2013/kawamuray/7001 -- https://wiki.qemu.org/Features/LibvirtWiresharkDissector + +* http://www.google-melange.com/gsoc/project/google/gsoc2013/kawamuray/7001 +* https://wiki.qemu.org/Features/LibvirtWiresharkDissector + Installation ============= -Run ./configure with --with-wireshark-dissector option enabled. + +Run ``./configure`` with ``--with-wireshark-dissector`` option enabled. Then dissector will compiled with libvirt itself. Add/Remove protocol from dissector's support -------------------------------------------- -Modify variable WS\_DISSECTOR\_PROTO\_FILES in tools/wireshark/src/Makefile.am. + +Modify variable ``WS_DISSECTOR_PROTO_FILES`` +in ``tools/wireshark/src/Makefile.am``. Changing installation directory ------------------------------- -You can change installation directory of pluggable shared object(libvirt.so) by -specifying --with-ws-plugindir=<path>. -You can install libvirt.so into your local wireshark plugin directory: +You can change installation directory of pluggable shared +object(``libvirt.so``) by specifying ``--with-ws-plugindir=<path>``. + +You can install ``libvirt.so`` into your local wireshark plugin directory: + +:: - ./configure --with-wireshark-dissector \ - --with-ws-plugindir=$HOME/.wireshark/plugins + $ ./configure --with-wireshark-dissector \ + --with-ws-plugindir=$HOME/.wireshark/plugins -- 2.25.2