docs: use "::" instead of ".. code-block::"

The former is a short hand for the latter and is already widely used in
the docs. Using the short hand avoids incompatibility with the alternate
impl of rst2html5.

Reviewed-by: Erik Skultety <eskultet@redhat.com>
Signed-off-by: Daniel P. Berrangé <berrange@redhat.com>
This commit is contained in:
Daniel P. Berrangé 2020-10-05 11:27:44 +01:00
parent 4d36554716
commit a7464a3f01
6 changed files with 327 additions and 327 deletions

View File

@ -199,7 +199,7 @@ EXAMPLES
To retrieve the version of libvirtd: To retrieve the version of libvirtd:
.. code-block:: ::
# libvirtd --version # libvirtd --version
libvirtd (libvirt) 0.8.2 libvirtd (libvirt) 0.8.2
@ -207,7 +207,7 @@ To retrieve the version of libvirtd:
To start libvirtd, instructing it to daemonize and create a PID file: To start libvirtd, instructing it to daemonize and create a PID file:
.. code-block:: ::
# libvirtd -d # libvirtd -d
# ls -la @RUNSTATEDIR@/libvirtd.pid # ls -la @RUNSTATEDIR@/libvirtd.pid

File diff suppressed because it is too large Load Diff

View File

@ -28,7 +28,7 @@ as for monitoring and managing all clients connected to the daemon.
The basic structure of most virt-admin usage is: The basic structure of most virt-admin usage is:
.. code-block:: ::
virt-admin [OPTION]... <command> [ARG]... virt-admin [OPTION]... <command> [ARG]...
@ -107,7 +107,7 @@ help
**Syntax:** **Syntax:**
.. code-block:: ::
help [command-or-group] help [command-or-group]
@ -124,7 +124,7 @@ quit, exit
**Syntax:** **Syntax:**
.. code-block:: ::
quit quit
exit exit
@ -136,7 +136,7 @@ version
**Syntax:** **Syntax:**
.. code-block:: ::
version version
@ -146,7 +146,7 @@ the version of the daemon.
**Example:** **Example:**
.. code-block:: ::
$ virt-admin version $ virt-admin version
Compiled against library: libvirt 1.2.21 Compiled against library: libvirt 1.2.21
@ -160,7 +160,7 @@ cd
**Syntax:** **Syntax:**
.. code-block:: ::
cd [directory] cd [directory]
@ -175,7 +175,7 @@ pwd
**Syntax:** **Syntax:**
.. code-block:: ::
pwd pwd
@ -187,7 +187,7 @@ connect
**Syntax:** **Syntax:**
.. code-block:: ::
connect [URI] connect [URI]
@ -206,7 +206,7 @@ uri
**Syntax:** **Syntax:**
.. code-block:: ::
uri uri
@ -230,7 +230,7 @@ server-list
**Syntax:** **Syntax:**
.. code-block:: ::
server-list server-list
@ -243,7 +243,7 @@ daemon-log-filters
**Syntax:** **Syntax:**
.. code-block:: ::
daemon-log-filters [--filters string] daemon-log-filters [--filters string]
@ -264,7 +264,7 @@ space. Each filter must conform to the form described in detail by
To define a filter which suppresses all e.g. 'virObjectUnref' DEBUG To define a filter which suppresses all e.g. 'virObjectUnref' DEBUG
messages, use the following: messages, use the following:
.. code-block:: ::
$ virt-admin daemon-log-filters "4:util.object" $ virt-admin daemon-log-filters "4:util.object"
@ -277,7 +277,7 @@ daemon-log-outouts
**Syntax:** **Syntax:**
.. code-block:: ::
daemon-log-outputs [--outputs string] daemon-log-outputs [--outputs string]
@ -298,13 +298,13 @@ space. Each output must conform to the form described in detail by
To replace the current setting for logging outputs with one that writes to To replace the current setting for logging outputs with one that writes to
a file while logging errors only, the following could be used: a file while logging errors only, the following could be used:
.. code-block:: ::
$ virt-admin daemon-log-outputs "4:file:<absolute_path_to_the_file>" $ virt-admin daemon-log-outputs "4:file:<absolute_path_to_the_file>"
To define multiple outputs at once they need to be delimited by spaces: To define multiple outputs at once they need to be delimited by spaces:
.. code-block:: ::
$ virt-admin daemon-log-outputs "4:stderr 2:syslog:<msg_ident>" $ virt-admin daemon-log-outputs "4:stderr 2:syslog:<msg_ident>"
@ -320,7 +320,7 @@ server-threadpool-info
**Syntax:** **Syntax:**
.. code-block:: ::
server-threadpool-info server server-threadpool-info server
@ -355,7 +355,7 @@ that, unlike tasks carried out by normal workers, are within libvirt's full
control and libvirt guarantees that such a task cannot hang, thus will always control and libvirt guarantees that such a task cannot hang, thus will always
finish. An example of such a task this would be destroying a domain: finish. An example of such a task this would be destroying a domain:
.. code-block:: ::
$ virsh destroy <domain>. $ virsh destroy <domain>.
@ -365,7 +365,7 @@ server-threadpool-set
**Syntax:** **Syntax:**
.. code-block:: ::
server-threadpool-set server [--min-workers count] [--max-workers count] [--priority-workers count] server-threadpool-set server [--min-workers count] [--max-workers count] [--priority-workers count]
@ -394,7 +394,7 @@ server-clients-info
**Syntax:** **Syntax:**
.. code-block:: ::
server-clients-info server server-clients-info server
@ -407,7 +407,7 @@ runtime values, more specifically, the current number of clients connected to
**Example:** **Example:**
.. code-block:: ::
# virt-admin server-clients-info libvirtd # virt-admin server-clients-info libvirtd
nclients_max : 120 nclients_max : 120
@ -421,7 +421,7 @@ server-clients-set
**Syntax:** **Syntax:**
.. code-block:: ::
server-clients-set server [--max-clients count] [--max-unauth-clients count] server-clients-set server [--max-clients count] [--max-unauth-clients count]
@ -447,7 +447,7 @@ server-update-tls
**Syntax:** **Syntax:**
.. code-block:: ::
server-update-tls server server-update-tls server
@ -474,7 +474,7 @@ client-list
**Syntax:** **Syntax:**
.. code-block:: ::
client-list server client-list server
@ -488,7 +488,7 @@ client-info
**Syntax:** **Syntax:**
.. code-block:: ::
client-info server client client-info server client
@ -504,7 +504,7 @@ enabled within daemon).
**Examples:** **Examples:**
.. code-block:: ::
# virt-admin client-info libvirtd 1 # virt-admin client-info libvirtd 1
id : 1 id : 1
@ -530,7 +530,7 @@ client-disconnect
**Syntax:** **Syntax:**
.. code-block:: ::
client-disconnect server client client-disconnect server client

View File

@ -29,7 +29,7 @@ configured in ``/etc/libvirt/virt-login-shell.conf``.
The basic structure of most ``virt-login-shell`` usage is: The basic structure of most ``virt-login-shell`` usage is:
.. code-block:: ::
virt-login-shell virt-login-shell
@ -58,7 +58,7 @@ By default, ``virt-login-shell`` will execute the ``/bin/sh`` program for
the user. You can modify this behaviour by defining the shell variable in the user. You can modify this behaviour by defining the shell variable in
``/etc/libvirt/virt-login-shell.conf``. e.g. ``/etc/libvirt/virt-login-shell.conf``. e.g.
.. code-block:: ::
shell = [ "/bin/bash" ] shell = [ "/bin/bash" ]
@ -68,7 +68,7 @@ detect the shell from ``/etc/password`` inside the container. This should only
be done if the container has a separate ``/etc`` directory from the host, be done if the container has a separate ``/etc`` directory from the host,
otherwise it will end up recursively invoking ``virt-login-shell``. e.g. otherwise it will end up recursively invoking ``virt-login-shell``. e.g.
.. code-block:: ::
auto_shell = 1 auto_shell = 1
@ -77,7 +77,7 @@ By default no users are allowed to use virt-login-shell, if you want to allow
certain users to use virt-login-shell, you need to modify the allowed_users certain users to use virt-login-shell, you need to modify the allowed_users
variable in /etc/libvirt/virt-login-shell.conf. e.g. variable in /etc/libvirt/virt-login-shell.conf. e.g.
.. code-block:: ::
allowed_users = [ "tom", "dick", "harry" ] allowed_users = [ "tom", "dick", "harry" ]

View File

@ -120,14 +120,14 @@ EXAMPLES
To retrieve the version of ``virtlockd``: To retrieve the version of ``virtlockd``:
.. code-block:: ::
# virtlockd --version # virtlockd --version
virtlockd (libvirt) 1.1.1 virtlockd (libvirt) 1.1.1
To start ``virtlockd``, instructing it to daemonize and create a PID file: To start ``virtlockd``, instructing it to daemonize and create a PID file:
.. code-block:: ::
# virtlockd -d # virtlockd -d
# ls -la @RUNSTATEDIR@/virtlockd.pid # ls -la @RUNSTATEDIR@/virtlockd.pid

View File

@ -121,14 +121,14 @@ EXAMPLES
To retrieve the version of ``virtlogd``: To retrieve the version of ``virtlogd``:
.. code-block:: ::
# virtlogd --version # virtlogd --version
virtlogd (libvirt) 1.1.1 virtlogd (libvirt) 1.1.1
To start ``virtlogd``, instructing it to daemonize and create a PID file: To start ``virtlogd``, instructing it to daemonize and create a PID file:
.. code-block:: ::
# virtlogd -d # virtlogd -d
# ls -la @RUNSTATEDIR@/virtlogd.pid # ls -la @RUNSTATEDIR@/virtlogd.pid