From 3332d410321088d88e47c75e54516b811854b8a0 Mon Sep 17 00:00:00 2001 From: parulin <161326115+parulin@users.noreply.github.com> Date: Thu, 31 Jul 2025 02:09:34 -0400 Subject: [PATCH] Minor cleaning of code highlighting * Most of text blocks are in fact output blocks * On qubes-iso-building.rst, try to get something correct for console lines starting with a comment * Fixing a wrong :menuselection: item. Statistics: 685 console 79 text 44 bash 35 output 16 yaml 9 systemd 9 c 8 python 4 ini 4 doscon 2 markdown 2 desktop 1 xorg.conf 1 xml+jinja 1 xml 1 kconfig 1 html --- developer/building/qubes-iso-building.rst | 46 ++++++++++++------- developer/code/code-signing.rst | 2 +- .../how-to-install-software-in-dom0.rst | 2 +- user/advanced-topics/mount-from-other-os.rst | 2 +- user/advanced-topics/salt.rst | 2 +- user/advanced-topics/standalones-and-hvms.rst | 2 +- .../upgrade/2b1.rst | 2 +- .../upgrade/2b2.rst | 2 +- .../upgrade/3_2.rst | 2 +- .../upgrade/4_1.rst | 2 +- .../upgrade/4_2.rst | 2 +- user/how-to-guides/how-to-update.rst | 2 +- user/how-to-guides/how-to-use-usb-devices.rst | 6 +-- user/security-in-qubes/mfa.rst | 2 +- user/templates/fedora/fedora-upgrade.rst | 4 +- user/templates/windows/windows-qubes-4-1.rst | 2 +- ...bian-and-whonix-update-troubleshooting.rst | 12 ++--- user/troubleshooting/disk-troubleshooting.rst | 2 +- user/troubleshooting/hvm-troubleshooting.rst | 2 +- user/troubleshooting/pci-troubleshooting.rst | 4 +- .../resume-suspend-troubleshooting.rst | 2 +- user/troubleshooting/usb-troubleshooting.rst | 4 +- user/troubleshooting/vpn-troubleshooting.rst | 2 +- 23 files changed, 61 insertions(+), 49 deletions(-) diff --git a/developer/building/qubes-iso-building.rst b/developer/building/qubes-iso-building.rst index a4c96cd8..f14523e4 100644 --- a/developer/building/qubes-iso-building.rst +++ b/developer/building/qubes-iso-building.rst @@ -46,9 +46,15 @@ Get the necessary keys to verify the sources (run these and other commands below $ gpg --import qubes-master-signing-key.asc $ gpg --edit-key 36879494 $ fpr - $ # Verify fingerprint! See Note below! - $ # Once verified, set trust to *ultimate* - $ # (Typical sequence is trust, 5, Y, q) + +.. code:: output + + # Verify fingerprint! See Note below! + # Once verified, set trust to *ultimate* + # (Typical sequence is trust, 5, Y, q) + +.. code:: console + $ wget https://keys.qubes-os.org/keys/qubes-developers-keys.asc $ gpg --import qubes-developers-keys.asc @@ -80,17 +86,20 @@ Let’s configure the builder first (see :ref:`procedure `__, etc. It should look something like this: -.. code:: text +.. code:: output pub rsa4096 2014-01-16 [SC] [expires: 2026-01-23] Key fingerprint = 916B 8D99 C38E AF5E 8ADC 7A2A 8D66 066A 2EEA CCDA diff --git a/developer/code/code-signing.rst b/developer/code/code-signing.rst index 348ff1b6..0c585214 100644 --- a/developer/code/code-signing.rst +++ b/developer/code/code-signing.rst @@ -68,7 +68,7 @@ In the example below, we will use ``keyserver.ubuntu.com``. Replace 6E2F4E7AF50A5827 with your key ID, preferably the **long keyID** which is the last 16 hex digits of the long number in the second line of the output above: -.. code:: text +.. code:: output pub rsa3072 2021-12-30 [SC] [expires: 2023-12-30] 87975838063F97A968D503266E2F4E7AF50A5827 diff --git a/user/advanced-topics/how-to-install-software-in-dom0.rst b/user/advanced-topics/how-to-install-software-in-dom0.rst index d9a5a102..e2c13d7f 100644 --- a/user/advanced-topics/how-to-install-software-in-dom0.rst +++ b/user/advanced-topics/how-to-install-software-in-dom0.rst @@ -213,6 +213,6 @@ Requires installed `Whonix `__. Go to Qubes VM Manager -> System -> Global Settings. See the UpdateVM setting. Choose your desired Whonix-Gateway ProxyVM from the list. For example: sys-whonix. -:menusettings:`Qubes VM Manager -> System -> Global Settings -> UpdateVM -> sys-whonix` +:menuselection:`Qubes VM Manager --> System --> Global Settings --> UpdateVM --> sys-whonix` diff --git a/user/advanced-topics/mount-from-other-os.rst b/user/advanced-topics/mount-from-other-os.rst index 8855ab9e..02f195ce 100644 --- a/user/advanced-topics/mount-from-other-os.rst +++ b/user/advanced-topics/mount-from-other-os.rst @@ -26,7 +26,7 @@ Decrypting the Disk 1. Open a Linux terminal in either dom0 or the app qube the disk was passed through to and enter ``lsblk``, which will result in an output similar to the following. In this example, the currently booted Qubes system is installed on ``sda`` and the qubes system to be accessed is on ``nvme0n1p2``. - .. code:: text + .. code:: output sda 8:0 0 111.8G 0 disk ├─sda1 8:1 0 200M 0 part /boot/efi diff --git a/user/advanced-topics/salt.rst b/user/advanced-topics/salt.rst index 0f546013..346dec9c 100644 --- a/user/advanced-topics/salt.rst +++ b/user/advanced-topics/salt.rst @@ -193,7 +193,7 @@ Configuring a qube's System from Dom0 Salt can be used to configure qubes from dom0. Simply set the qube name as the target minion name in the top file. You can also use the ``qubes`` pillar module to select qubes with a particular property (see below). If you do so, then you need to pass additional arguments to the ``qubesctl`` tool: -.. code:: text +.. code:: output usage: qubesctl [-h] [--show-output] [--force-color] [--skip-dom0] [--targets TARGETS | --templates | --app | --all] diff --git a/user/advanced-topics/standalones-and-hvms.rst b/user/advanced-topics/standalones-and-hvms.rst index 90669dff..71aad754 100644 --- a/user/advanced-topics/standalones-and-hvms.rst +++ b/user/advanced-topics/standalones-and-hvms.rst @@ -96,7 +96,7 @@ Qubes are template-based (i.e., :ref:`app qubes .x86_64.rpm: Header V3 RSA/SHA256 Signature, key ID XXXXXXXX: NOKEY Importing GPG key 0xXXXXXXXX: @@ -206,7 +206,7 @@ Additional information As mentioned above, you may encounter the following ``dnf`` error: -.. code:: text +.. code:: output At least X MB more space needed on the / filesystem. diff --git a/user/templates/windows/windows-qubes-4-1.rst b/user/templates/windows/windows-qubes-4-1.rst index be4ee5ef..a72ede3b 100644 --- a/user/templates/windows/windows-qubes-4-1.rst +++ b/user/templates/windows/windows-qubes-4-1.rst @@ -167,7 +167,7 @@ These parameters are set for the following reasons: - The Windows’ installer requires a significant amount of memory or else the VM will crash with such errors: - .. code:: text + .. code:: output /var/log/xen/console/hypervisor.log: diff --git a/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst b/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst index 04f775c8..7aab5aa4 100644 --- a/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst +++ b/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst @@ -23,7 +23,7 @@ After running the commands to update Debian or Whonix, hopefully everything will However, if you see something like the following, then something went wrong. -.. code:: text +.. code:: output W: Failed to fetch http://ftp.us.debian.org/debian/dist/jessie/contrib/binary-i386/Packages 404 Not Found @@ -60,7 +60,7 @@ This could be a temporary Tor exit relay or server failure that should fix itsel Sometimes if you see a message such as: -.. code:: text +.. code:: output Could not resolve 'security.debian.org' @@ -90,7 +90,7 @@ Never Install Unsigned Packages If you see something like this: -.. code:: text +.. code:: output WARNING: The following packages cannot be authenticated! icedove @@ -106,7 +106,7 @@ Signature Verification Warnings There should be none at the moment. If there was such a warning, it would look like this: -.. code:: text +.. code:: output W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 @@ -120,7 +120,7 @@ In past various apt repositories were signed with expired key: `The Tor Project You saw the following warning: -.. code:: text +.. code:: output W: A error occurred during the signature verification. The repository is not updated and the previous index files will be used. GPG error: http://deb.torproject.org stable Release: The following signatures were invalid: KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 KEYEXPIRED 1409325681 @@ -139,7 +139,7 @@ Changed Configuration Files If you see something like the following. -.. code:: text +.. code:: output Setting up ifupdown ... Configuration file /etc/network/interfaces diff --git a/user/troubleshooting/disk-troubleshooting.rst b/user/troubleshooting/disk-troubleshooting.rst index b2fe840a..e6318031 100644 --- a/user/troubleshooting/disk-troubleshooting.rst +++ b/user/troubleshooting/disk-troubleshooting.rst @@ -9,7 +9,7 @@ Disk troubleshooting If the disk is completely full, you will get an ``Out of disk space`` error that may crash your system because Dom0 does not have enough disk space to work. So it’s good practice to regularly check disk space usage. Running the ``df -h`` command in dom0 terminal will show some information, but not include all the relevant details. The Qubes user interface provides a disk space widget. If you are unable to access the interface, the command line version is running ``sudo lvs | head`` and looking at top entry for LVM pool. For example: -.. code:: text +.. code:: output LV VG Attr LSize Pool Origin Data% Meta% Move Log Cpy%Sync Convert pool00 qubes_dom0 twi-aotz-- 453.17g 89.95 69.78 diff --git a/user/troubleshooting/hvm-troubleshooting.rst b/user/troubleshooting/hvm-troubleshooting.rst index 2b444404..2f1c572b 100644 --- a/user/troubleshooting/hvm-troubleshooting.rst +++ b/user/troubleshooting/hvm-troubleshooting.rst @@ -9,7 +9,7 @@ HVM pauses on boot, followed by kernel error The HVM may pause on boot, showing a fixed cursor. After a while a series of warnings may be shown similar to this: -.. code:: text +.. code:: output BUG: soft lockup - CPU#0 stuck for 23s! [systemd-udevd:244] diff --git a/user/troubleshooting/pci-troubleshooting.rst b/user/troubleshooting/pci-troubleshooting.rst index 437f73a0..d6ddfdca 100644 --- a/user/troubleshooting/pci-troubleshooting.rst +++ b/user/troubleshooting/pci-troubleshooting.rst @@ -55,7 +55,7 @@ Using the command line 1. To see all the PCI available devices, enter the ``lspci`` command into the dom0 terminal. Each device will be listed on a line, for example: - .. code:: text + .. code:: output 0000:03:00.0 Audio device: Intel Corporation Haswell-ULT HD Audio Controller (rev 0b) @@ -64,7 +64,7 @@ Using the command line 2. Now that you can see all the PCI devices and their BDFs, you can decide which to remove and which to keep. Imagine we faced the following error message: - .. code:: text + .. code:: output libvirt.libvirtError: internal error: Unable to reset PCI device 0000:03:00.1: internal error: Active 0000:03:00.0 devices on bus with 0000:03:00.1, not doing bus reset diff --git a/user/troubleshooting/resume-suspend-troubleshooting.rst b/user/troubleshooting/resume-suspend-troubleshooting.rst index d61d9ecf..38f49d6a 100644 --- a/user/troubleshooting/resume-suspend-troubleshooting.rst +++ b/user/troubleshooting/resume-suspend-troubleshooting.rst @@ -39,7 +39,7 @@ Checking logs for relevant messages View the output of ``dmesg`` in sys-net, and check if you see a bunch of wireless related errors. Depending on your hardware, they may look like the following (or not): -.. code:: text +.. code:: output iwlwifi 0000:00:00.0: loaded firmware version 16.242414.0 op_mode iwlmvm iwlwifi 0000:00:00.0: Detected Intel(R) Dual Band Wireless AC 8260, REV=0x208 diff --git a/user/troubleshooting/usb-troubleshooting.rst b/user/troubleshooting/usb-troubleshooting.rst index 9cc28477..02b094bf 100644 --- a/user/troubleshooting/usb-troubleshooting.rst +++ b/user/troubleshooting/usb-troubleshooting.rst @@ -51,7 +51,7 @@ Errors suggesting this issue: - in ``xl dmesg`` output: - .. code:: text + .. code:: output (XEN) [VT-D] It's disallowed to assign 0000:00:1a.0 with shared RMRR at dbe9a000 for Dom19. (XEN) XEN_DOMCTL_assign_device: assign 0000:00:1a.0 to dom19 failed (-1) @@ -60,7 +60,7 @@ Errors suggesting this issue: - during ``qvm-start sys-usb``: - .. code:: text + .. code:: output internal error: Unable to reset PCI device [...] no FLR, PM reset or bus reset available. diff --git a/user/troubleshooting/vpn-troubleshooting.rst b/user/troubleshooting/vpn-troubleshooting.rst index 9aca8e78..60e09a5f 100644 --- a/user/troubleshooting/vpn-troubleshooting.rst +++ b/user/troubleshooting/vpn-troubleshooting.rst @@ -45,7 +45,7 @@ To figure out the root of the problem, check the VPN logs in ``/var/log/syslog`` `Some VPN guides `__ use complex scripts that include a call to ``notify-send``, yet some images may not contain this tool or may not have it working properly. For instance calling ``notify-send`` on a ``fedora-36`` template VM gives: -.. code:: text +.. code:: output Failed to execute child process “dbus-launch” (No such file or directory)