5:30 a.m.
This patchset:
1) converts the 'kbase' directory page to RST
2) increases width of the container holding the kbase articles:
before:
https://libvirt.org/kbase.html
after:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
3) ports 'debuglogs' wiki article to the kbase:
original:
https://wiki.libvirt.org/page/DebugLogs
converted:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
Note that this patchset requires Pavel's meson rewrite.
Peter Krempa (3):
docs: kbase: Convert 'kbase' article registry to RST
docs: kbase: Make kbase article directory wider
docs: kbase: Port 'debuglogs' document from libvirt's wiki
docs/kbase.html.in | 54 --------------
docs/kbase.rst | 46 ++++++++++++
docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
docs/kbase/meson.build | 1 +
docs/libvirt.css | 8 +++
docs/meson.build | 2 +-
6 files changed, 204 insertions(+), 55 deletions(-)
delete mode 100644 docs/kbase.html.in
create mode 100644 docs/kbase.rst
create mode 100644 docs/kbase/debuglogs.rst
--
2.26.2
5:30 a.m.
New subject: [PATCH 1/3] docs: kbase: Convert 'kbase' article registry to RST
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
docs/kbase.html.in | 54 ----------------------------------------------
docs/kbase.rst | 43 ++++++++++++++++++++++++++++++++++++
docs/meson.build | 2 +-
3 files changed, 44 insertions(+), 55 deletions(-)
delete mode 100644 docs/kbase.html.in
create mode 100644 docs/kbase.rst
diff --git a/docs/kbase.html.in b/docs/kbase.html.in
deleted file mode 100644
index 3ca0d0734d..0000000000
--- a/docs/kbase.html.in
+++ /dev/null
@@ -1,54 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html>
-<html xmlns="http://www.w3.org/1999/xhtml">
- <body class="docs">
- <h1>Knowledge base</h1>
-
- <div class="panel">
- <dl>
- <dt><a href="kbase/locking.html">Disk
locking</a></dt>
- <dd>Ensuring exclusive guest access to disks with
- <a href="kbase/locking-lockd.html">virtlockd</a> or
- <a
href="kbase/locking-sanlock.html">Sanlock</a></dd>
-
- <dt><a href="kbase/secureusage.html">Secure
usage</a></dt>
- <dd>Secure usage of the libvirt APIs</dd>
-
- <dt><a href="kbase/s390_protected_virt.html">Protected
virtualization on s390</a></dt>
- <dd>Running secure s390 guests with IBM Secure Execution</dd>
-
- <dt><a href="kbase/launch_security_sev.html">Launch
security</a></dt>
- <dd>Securely launching VMs with AMD SEV</dd>
-
- <dt><a href="kbase/domainstatecapture.html">Domain state
- capture</a></dt>
- <dd>Comparison between different methods of capturing domain
- state</dd>
-
- <dt><a href="kbase/rpm-deployment.html">RPM
deployment</a></dt>
- <dd>Explanation of the different RPM packages and illustration of
- which to pick for installation</dd>
-
- <dt><a href="kbase/backing_chains.html">Backing chain
management</a></dt>
- <dd>Explanation of how disk backing chain specification impacts
libvirt's
- behaviour and basic troubleshooting steps of disk problems.</dd>
-
- <dt><a href="kbase/qemu-passthrough-security.html">Security
with QEMU passthrough</a></dt>
- <dd>Examination of the security protections used for QEMU and how they
need
- configuring to allow use of QEMU passthrough with host
files/devices.</dd>
-
- <dt><a
href="kbase/virtiofs.html">Virtio-FS</a></dt>
- <dd>Share a filesystem between the guest and the host</dd>
-
- <dt><a href="kbase/kvm-realtime.html">KVM real
time</a></dt>
- <dd>Run real time workloads in guests on a KVM hypervisor</dd>
-
- <dt><a
href="kbase/incrementalbackupinternals.html">Incremental backup
internals</a></dt>
- <dd>Incremental backup implementation details relevant for
users</dd>
- </dl>
- </div>
-
- <br class="clear"/>
-
- </body>
-</html>
diff --git a/docs/kbase.rst b/docs/kbase.rst
new file mode 100644
index 0000000000..509fb6e34e
--- /dev/null
+++ b/docs/kbase.rst
@@ -0,0 +1,43 @@
+==============
+Knowledge base
+==============
+
+.. container:: panel
+
+ `Disk locking <kbase/locking.html>`__
+ Ensuring exclusive guest access to disks with
+ `virtlockd <kbase/locking-lockd.html>`__ or
+ `Sanlock <kbase/locking-sanlock.html>`__
+
+ `Secure usage <kbase/secureusage.html>`__
+ Secure usage of the libvirt APIs
+
+ `Protected virtualization on s390 <kbase/s390_protected_virt.html>`__
+ Running secure s390 guests with IBM Secure Execution
+
+ `Launch security <kbase/launch_security_sev.html>`__
+ Securely launching VMs with AMD SEV
+
+ `Domain state capture <kbase/domainstatecapture.html>`__
+ Comparison between different methods of capturing domain state
+
+ `RPM deployment <kbase/rpm-deployment.html>`__
+ Explanation of the different RPM packages and illustration of which to
+ pick for installation
+
+ `Backing chain management <kbase/backing_chains.html>`__
+ Explanation of how disk backing chain specification impacts libvirt's
+ behaviour and basic troubleshooting steps of disk problems.
+
+ `Security with QEMU passthrough <kbase/qemu-passthrough-security.html>`__
+ Examination of the security protections used for QEMU and how they need
+ configuring to allow use of QEMU passthrough with host files/devices.
+
+ `Virtio-FS <kbase/virtiofs.html>`__
+ Share a filesystem between the guest and the host
+
+ `KVM real time <kbase/kvm-realtime.html>`__
+ Run real time workloads in guests on a KVM hypervisor
+
+ `Incremental backup internals <kbase/incrementalbackupinternals.html>`__
+ Incremental backup implementation details relevant for users
diff --git a/docs/meson.build b/docs/meson.build
index c2d7fd1bf4..2f06e8eace 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -87,7 +87,6 @@ docs_html_in_files = [
'index',
'internals',
'java',
- 'kbase',
'logging',
'migration',
'nss',
@@ -119,6 +118,7 @@ docs_rst_files = [
'formatbackup',
'formatcheckpoint',
'hacking',
+ 'kbase',
'libvirt-go',
'libvirt-go-xml',
'newreposetup',
--
2.26.2
5:30 a.m.
New subject: [PATCH 2/3] docs: kbase: Make kbase article directory wider
Set the width to our default value of 70em (max 95%) to prevent
unnecessary line breaks if we have just one panel as it's in the kbase
directory.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
docs/kbase.rst | 2 +-
docs/libvirt.css | 8 ++++++++
2 files changed, 9 insertions(+), 1 deletion(-)
diff --git a/docs/kbase.rst b/docs/kbase.rst
index 509fb6e34e..767c08e637 100644
--- a/docs/kbase.rst
+++ b/docs/kbase.rst
@@ -2,7 +2,7 @@
Knowledge base
==============
-.. container:: panel
+.. container:: panel widepanel
`Disk locking <kbase/locking.html>`__
Ensuring exclusive guest access to disks with
diff --git a/docs/libvirt.css b/docs/libvirt.css
index 3f0fd93089..551adac2f2 100644
--- a/docs/libvirt.css
+++ b/docs/libvirt.css
@@ -402,6 +402,14 @@ div.panel {
background: rgb(230, 230, 230);
}
+div.widepanel {
+ width: 70em;
+ max-width: 95%;
+ margin-left: 0px;
+ float: left;
+ background: rgb(230, 230, 230);
+}
+
div.panel h2 {
margin-top: 0px;
padding: 0.5em;
--
2.26.2
5:30 a.m.
New subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki
Provide debug log configuration insight in our kbase.
There are two modifications of the document compared to the wiki
version:
1) The link for reporting a bug agains libvirt was modified to use the
gitlab issue tracker.
2) The link to URI specification details is changed to 'https' protocol.
Signed-off-by: Peter Krempa <pkrempa(a)redhat.com>
---
docs/kbase.rst | 3 +
docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
docs/kbase/meson.build | 1 +
3 files changed, 152 insertions(+)
create mode 100644 docs/kbase/debuglogs.rst
diff --git a/docs/kbase.rst b/docs/kbase.rst
index 767c08e637..78daaa5989 100644
--- a/docs/kbase.rst
+++ b/docs/kbase.rst
@@ -4,6 +4,9 @@ Knowledge base
.. container:: panel widepanel
+ `Debug logs <kbase/debuglogs.html>`__
+ Configuration of logging and tips on how to file a good bug report.
+
`Disk locking <kbase/locking.html>`__
Ensuring exclusive guest access to disks with
`virtlockd <kbase/locking-lockd.html>`__ or
diff --git a/docs/kbase/debuglogs.rst b/docs/kbase/debuglogs.rst
new file mode 100644
index 0000000000..decc53a69b
--- /dev/null
+++ b/docs/kbase/debuglogs.rst
@@ -0,0 +1,148 @@
+==========
+Debug Logs
+==========
+
+.. contents::
+
+Turning on debug logs
+---------------------
+
+If you `report a bug <https://gitlab.com/libvirt/libvirt/-/issues/new>`__
+against libvirt, in most cases you will be asked to attach debug logs. These
+are bare text files which tracks transition between different states of
+libvirtd, what it has tried to achieve, etc. Because of client -- server schema
+used in libvirt, the logs can be either client or server too. Usually, it's
+server side that matters as nearly all interesting work takes place there.
+Moreover, libvirt catches stderr of all running domains. These can be useful as
+well.
+
+
+How to turn on debug logs for libvirt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Persistent setting
+^^^^^^^^^^^^^^^^^^
+
+The daemon configuration files location is dependent on `connection
+URI <https://libvirt.org/uri.html>`__. For ``qemu:///system``:
+
+
+
+- open ``/etc/libvirt/libvirtd.conf`` in your favourite editor
+- find & replace, or set these variables:
+
+::
+
+ # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
+ log_level = 1
+ log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
+ log_outputs="1:file:/var/log/libvirt/libvirtd.log"
+
+::
+
+ # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
+ log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
+ log_outputs="1:file:/var/log/libvirt/libvirtd.log"
+
+- save and exit
+- restart libvirtd service
+
+::
+
+ systemctl restart libvirtd.service
+
+In the config variables above, we have set logging level to 1 (debug level), set
+some filters (to filter out noise), e.g. from rpc only warnings (=level 3) and
+above will be reported. The logs are saved into
+``/var/log/libvirt/libvirtd.log``. Since libvirt **4.4.0** log filters support
+shell globbing, therefore the usage of ``log_level`` is considered deprecated in
+favour of pure usage of ``log_filters``.
+
+In case you want to get the client logs, you need to set this environment
+variable:
+
+::
+
+ export LIBVIRT_LOG_OUTPUTS="1:file:/tmp/libvirt_client.log"
+
+
+However, when you are using the session mode ``qemu:///session`` or you run the
+``libvirtd`` as unprivileged user you will find configuration file under
+``$XDG_CONFIG_HOME/libvirt/libvirt.conf``.
+
+Runtime setting
+^^^^^^^^^^^^^^^
+
+Debugging anomalies can be very painful, especially when trying to reproduce it
+after the daemon restarts, since the new session can make the anomaly
+"disappear". Therefore, it's possible to enable the debug logs during
runtime
+using libvirt administration API. To use it conveniently, there's a virt-admin
+client provided by the libvirt-admin package. Use the package manager provided
+by your distribution to install this package. Once you have it installed, run
+the following as root to see the set of log filters currently being active:
+
+::
+
+ # virt-admin daemon-log-filters
+ Logging filters: 3:remote 4:util.json 4:rpc
+
+In order to change this set, run the same command as root, this time with your
+own set of filters:
+
+::
+
+ ## LEGACY APPROACH ENUMERATING ALL THE DESIRED MODULES ##
+ # virt-admin daemon-log-filters "1:util 1:libvirt 1:storage 1:network 1:nodedev
1:qemu"
+
+::
+
+ ## CURRENT APPROACH USING SHELL GLOBBING ##
+ # virt-admin daemon-log-filters "3:remote 4:util.json 4:rpc 1:*"
+
+Analogically, the same procedure can be performed with log outputs:
+
+::
+
+ # virt-admin daemon-log-outputs
+ Logging outputs: 3:syslog:libvirtd
+ # virt-admin daemon-log-outputs "1:file:/var/log/libvirt/libvirtd.log"
+
+NOTE: It's always good practice to return the settings to the original state
+once you're finished debugging, just remember to save the original sets of
+filters and outputs and restore them at the end the same way as described above.
+
+Removing filters and outputs
+''''''''''''''''''''''''''''
+
+It's also possible to remove all the filters and produce an enormous log file,
+but it is not recommended since some of libvirt's modules can produce a large
+amount of noise. However, should you really want to do this, you can specify an
+empty set of filters:
+
+::
+
+ # virt-admin daemon-log-filters ""
+ Logging filters:
+
+The situation is a bit different with outputs, since libvirt always has to log
+somewhere and resetting the outputs to an empty set will restore the default
+setting which depends on the host configuration, *journald* in our case:
+
+::
+
+ # virt-admin daemon-log-outputs
+ Logging outputs: 1:file:/var/log/libvirt/libvirtd.log
+ # virt-admin daemon-log-outputs ""
+ Logging outputs: 2:journald
+
+What to attach?
+~~~~~~~~~~~~~~~
+
+Now you should go and reproduce the bug. Once you're finished, attach:
+
+- ``/var/log/libvirt/libvirtd.log`` or whatever path you set for the daemon
+ logs.
+- If the problem is related to a domain attach
+ ``/var/log/libvirt/qemu/$dom.log`` then. Or substitute ``qemu`` with whatever
+ hypervisor you are using.
+- If you are asked for client logs, ``/tmp/libvirt_client.log``.
diff --git a/docs/kbase/meson.build b/docs/kbase/meson.build
index f72e426223..d7f254e163 100644
--- a/docs/kbase/meson.build
+++ b/docs/kbase/meson.build
@@ -1,5 +1,6 @@
docs_kbase_files = [
'backing_chains',
+ 'debuglogs',
'domainstatecapture',
'incrementalbackupinternals',
'kvm-realtime',
--
2.26.2
4:44 a.m.
New subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki
On Thu, Jul 30, 2020 at 12:30:32PM +0200, Peter Krempa wrote:
(Probably this needs to be done in a separate patch from this Wiki->rST
conversion, but a quick point inline.)
[...]
+How to turn on debug logs for libvirt
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Persistent setting
+^^^^^^^^^^^^^^^^^^
[...]
+
+ # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
+ log_level = 1
+ log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
+ log_outputs="1:file:/var/log/libvirt/libvirtd.log"
+
+::
+
+ # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
+ log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
The above "PREFERRED" settings doesn't capture QMP commands, does it?
The '1:qemu' is supposed to do it.
FWIW, after some debugging sessions with Dan Berrangé, I have been using
the following filters:
"1:libvirt 1:qemu 1:conf 1:security 3:event 3:json 3:file 3:object 1:util"
Should the document be updated with the above filters? (Assuming this
set looks good to the reviewers.)
+ log_outputs="1:file:/var/log/libvirt/libvirtd.log"
[...]
--
/kashyap
4:53 a.m.
New subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki
On Mon, Aug 03, 2020 at 11:44:39 +0200, Kashyap Chamarthy wrote:
On Thu, Jul 30, 2020 at 12:30:32PM +0200, Peter Krempa wrote:
(Probably this needs to be done in a separate patch from this Wiki->rST
conversion, but a quick point inline.)
Yes.
[...]
> +How to turn on debug logs for libvirt
> +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +
> +Persistent setting
> +^^^^^^^^^^^^^^^^^^
[...]
> +
> + # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
> + log_level = 1
> + log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
> + log_outputs="1:file:/var/log/libvirt/libvirtd.log"
> +
> +::
> +
> + # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
> + log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
The above "PREFERRED" settings doesn't capture QMP commands, does it?
The '1:qemu' is supposed to do it.
It has 1:* since after 4 it supports wildcats which is equivalent to
1:qemu.
FWIW, after some debugging sessions with Dan Berrangé, I have been
using
the following filters:
"1:libvirt 1:qemu 1:conf 1:security 3:event 3:json 3:file 3:object 1:util"
Didn't you debug a 4.4.0 or older libvirt?
Should the document be updated with the above filters? (Assuming this
set looks good to the reviewers.)
5:09 a.m.
New subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki
On Mon, Aug 03, 2020 at 11:53:20AM +0200, Peter Krempa wrote:
On Mon, Aug 03, 2020 at 11:44:39 +0200, Kashyap Chamarthy wrote:
[...]
> > +
> > + # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
> > + log_level = 1
> > + log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
> > + log_outputs="1:file:/var/log/libvirt/libvirtd.log"
> > +
> > +::
> > +
> > + # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
> > + log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
>
> The above "PREFERRED" settings doesn't capture QMP commands, does it?
> The '1:qemu' is supposed to do it.
It has 1:* since after 4 it supports wildcats which is equivalent to
1:qemu.
Ah, I missed to notice the above wildcat! :-)
Thanks; then no need for an edit to to doc.
Though I suspect the 1:* logs a bit more than the below targetted
filters.
> FWIW, after some debugging sessions with Dan Berrangé, I have
been using
> the following filters:
>
> "1:libvirt 1:qemu 1:conf 1:security 3:event 3:json 3:file 3:object
1:util"
Didn't you debug a 4.4.0 or older libvirt?
Pretty sure I did :-) I forget what filters I used when.
[...]
--
/kashyap
6:02 a.m.
New subject: [PATCH 3/3] docs: kbase: Port 'debuglogs' document from libvirt's wiki
On Mon, Aug 03, 2020 at 11:53:20AM +0200, Peter Krempa wrote:
On Mon, Aug 03, 2020 at 11:44:39 +0200, Kashyap Chamarthy wrote:
> On Thu, Jul 30, 2020 at 12:30:32PM +0200, Peter Krempa wrote:
>
> (Probably this needs to be done in a separate patch from this Wiki->rST
> conversion, but a quick point inline.)
Yes.
>
> [...]
>
> > +How to turn on debug logs for libvirt
> > +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> > +
> > +Persistent setting
> > +^^^^^^^^^^^^^^^^^^
>
> [...]
>
> > +
> > + # LEGACY SETTINGS PRIOR LIBVIRT 4.4.0 SEE BELOW! #
> > + log_level = 1
> > + log_filters="1:qemu 3:remote 4:event 3:util.json 3:rpc"
> > + log_outputs="1:file:/var/log/libvirt/libvirtd.log"
> > +
> > +::
> > +
> > + # PREFERRED SETTINGS AFTER LIBVIRT 4.4.0 #
> > + log_filters="3:remote 4:event 3:util.json 3:rpc 1:*"
>
> The above "PREFERRED" settings doesn't capture QMP commands, does it?
> The '1:qemu' is supposed to do it.
It has 1:* since after 4 it supports wildcats which is equivalent to
1:qemu.
> FWIW, after some debugging sessions with Dan Berrangé, I have been using
> the following filters:
>
> "1:libvirt 1:qemu 1:conf 1:security 3:event 3:json 3:file 3:object
1:util"
Didn't you debug a 4.4.0 or older libvirt?
This syntax above works fine on any version. The doc you've proposed here
needed differnet syntax for pre-4.4.0 since it is attempting to enable
wildcards via log_debug=1 or 1:*
In OSP we never try todo that as it is almost always overkill. Instead
we tell users to just explicitly list each category that is considered
important and don't use the wildcards.
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 :|
5:54 a.m.
On 7/30/20 12:30 PM, Peter Krempa wrote:
This patchset:
1) converts the 'kbase' directory page to RST
2) increases width of the container holding the kbase articles:
before:
https://libvirt.org/kbase.html
after:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
3) ports 'debuglogs' wiki article to the kbase:
original:
https://wiki.libvirt.org/page/DebugLogs
converted:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
Note that this patchset requires Pavel's meson rewrite.
Peter Krempa (3):
docs: kbase: Convert 'kbase' article registry to RST
docs: kbase: Make kbase article directory wider
docs: kbase: Port 'debuglogs' document from libvirt's wiki
docs/kbase.html.in | 54 --------------
docs/kbase.rst | 46 ++++++++++++
docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
docs/kbase/meson.build | 1 +
docs/libvirt.css | 8 +++
docs/meson.build | 2 +-
6 files changed, 204 insertions(+), 55 deletions(-)
delete mode 100644 docs/kbase.html.in
create mode 100644 docs/kbase.rst
create mode 100644 docs/kbase/debuglogs.rst
Reviewed-by: Michal Privoznik <mprivozn(a)redhat.com>
Michal
6:46 a.m.
On a Thursday in 2020, Peter Krempa wrote:
This patchset:
1) converts the 'kbase' directory page to RST
2) increases width of the container holding the kbase articles:
before:
https://libvirt.org/kbase.html
after:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
3) ports 'debuglogs' wiki article to the kbase:
original:
https://wiki.libvirt.org/page/DebugLogs
converted:
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
Note that this patchset requires Pavel's meson rewrite.
Peter Krempa (3):
docs: kbase: Convert 'kbase' article registry to RST
docs: kbase: Make kbase article directory wider
Any ideas on how to make the 'Contents' section look nicer?
Namely:
* 'Contents' feels like the equivalent of // THIS IS BRIDGE [0]
* the spacing between the ToC and the first headline is too small
for my taste
docs: kbase: Port 'debuglogs' document from libvirt's
wiki
docs/kbase.html.in | 54 --------------
docs/kbase.rst | 46 ++++++++++++
docs/kbase/debuglogs.rst | 148 +++++++++++++++++++++++++++++++++++++++
docs/kbase/meson.build | 1 +
docs/libvirt.css | 8 +++
docs/meson.build | 2 +-
6 files changed, 204 insertions(+), 55 deletions(-)
delete mode 100644 docs/kbase.html.in
create mode 100644 docs/kbase.rst
create mode 100644 docs/kbase/debuglogs.rst
Thank you.
Reviewed-by: Ján Tomko <jtomko(a)redhat.com>
Jano
[0] https://www.abstrusegoose.com/432
6:55 a.m.
On Sun, Aug 02, 2020 at 13:46:51 +0200, Ján Tomko wrote:
On a Thursday in 2020, Peter Krempa wrote:
> This patchset:
>
> 1) converts the 'kbase' directory page to RST
>
> 2) increases width of the container holding the kbase articles:
>
> before:
> https://libvirt.org/kbase.html
>
> after:
>
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
>
> 3) ports 'debuglogs' wiki article to the kbase:
>
> original:
> https://wiki.libvirt.org/page/DebugLogs
> converted:
>
https://pipo.sk.gitlab.io/-/libvirt/-/jobs/663385238/artifacts/website/kb...
>
> Note that this patchset requires Pavel's meson rewrite.
>
> Peter Krempa (3):
> docs: kbase: Convert 'kbase' article registry to RST
> docs: kbase: Make kbase article directory wider
Any ideas on how to make the 'Contents' section look nicer?
Namely:
* 'Contents' feels like the equivalent of // THIS IS BRIDGE [0]
https://www.redhat.com/archives/libvir-list/2020-August/msg00063.html
* the spacing between the ToC and the first headline is too small
for my taste
https://www.redhat.com/archives/libvir-list/2020-August/msg00062.html
or
https://www.redhat.com/archives/libvir-list/2020-August/msg00064.html
Refer to the cover letter for links to rendered pages:
https://www.redhat.com/archives/libvir-list/2020-August/msg00059.html
8:10 a.m.
On Thu, 2020-07-30 at 12:30 +0200, Peter Krempa wrote:
Peter Krempa (3):
docs: kbase: Convert 'kbase' article registry to RST
docs: kbase: Make kbase article directory wider
docs: kbase: Port 'debuglogs' document from libvirt's wiki
I just realized that, despite this series having been merged for a
long time, the original wiki page[1] still exists and its contents
are the same as they were back in July.
Can someone with write access to the wiki please turn it into a short
stub that points people to the kbase article[2] instead?
Thanks!
[1] https://wiki.libvirt.org/page/DebugLogs
[2] https://libvirt.org/kbase/debuglogs.html
--
Andrea Bolognani / Red Hat / Virtualization
8:14 a.m.
On a Friday in 2020, Andrea Bolognani wrote:
On Thu, 2020-07-30 at 12:30 +0200, Peter Krempa wrote:
> Peter Krempa (3):
> docs: kbase: Convert 'kbase' article registry to RST
> docs: kbase: Make kbase article directory wider
> docs: kbase: Port 'debuglogs' document from libvirt's wiki
I just realized that, despite this series having been merged for a
long time, the original wiki page[1] still exists and its contents
are the same as they were back in July.
Can someone with write access to the wiki please turn it into a short
stub that points people to the kbase article[2] instead?
Done. Hope it's short enough for your taste.
Jano
Thanks!
[1] https://wiki.libvirt.org/page/DebugLogs
[2] https://libvirt.org/kbase/debuglogs.html
--
Andrea Bolognani / Red Hat / Virtualization
9:15 a.m.
On Fri, 2020-11-13 at 15:14 +0100, Ján Tomko wrote:
On a Friday in 2020, Andrea Bolognani wrote:
> Can someone with write access to the wiki please turn it into a short
> stub that points people to the kbase article[2] instead?
Done. Hope it's short enough for your taste.
It definitely does the trick :) Thank you!
--
Andrea Bolognani / Red Hat / Virtualization
1283
days inactive
1389
days old
13 comments
6 participants
participants (6)
-
Andrea Bolognani -
Daniel P. Berrangé -
Ján Tomko -
Kashyap Chamarthy -
Michal Privoznik -
Peter Krempa