From 0cfd7552953e22a4ef4ea16ecec6d7da6546a585 Mon Sep 17 00:00:00 2001 From: Tobias Killer Date: Sat, 9 Aug 2025 09:50:36 +0200 Subject: [PATCH] Fix formattings and other issues See issue 8180. --- developer/building/qubes-builder.rst | 2 +- developer/code/code-signing.rst | 1 + developer/code/coding-style.rst | 2 +- developer/code/source-code.rst | 1 + developer/debugging/vm-interface.rst | 6 +-- developer/general/usability-ux.rst | 10 ++--- developer/releases/4_0/release-notes.rst | 1 + developer/services/admin-api.rst | 24 +++++------- developer/services/qrexec.rst | 5 ++- introduction/intro.rst | 2 +- user/advanced-topics/kde.rst | 2 +- user/advanced-topics/managing-vm-kernels.rst | 38 +++++++++---------- user/advanced-topics/salt.rst | 6 +-- user/advanced-topics/secondary-storage.rst | 4 +- .../upgrade/4_1.rst | 8 ++-- .../upgrade/4_2.rst | 8 ++-- .../certified-hardware/certified-hardware.rst | 4 +- user/templates/templates.rst | 3 +- .../windows/qubes-windows-tools-4-0.rst | 6 +-- .../windows/qubes-windows-tools-4-1.rst | 4 +- user/templates/windows/windows-qubes-4-0.rst | 3 ++ ...bian-and-whonix-update-troubleshooting.rst | 6 +-- user/troubleshooting/gui-troubleshooting.rst | 2 +- user/troubleshooting/uefi-troubleshooting.rst | 38 ++++++++++++++++++- user/troubleshooting/vm-troubleshooting.rst | 4 +- 25 files changed, 114 insertions(+), 76 deletions(-) diff --git a/developer/building/qubes-builder.rst b/developer/building/qubes-builder.rst index 02d815dc..b92c415a 100644 --- a/developer/building/qubes-builder.rst +++ b/developer/building/qubes-builder.rst @@ -146,7 +146,7 @@ You can also modify sources somehow if you wish. Here are some basic steps: -- You can also set GIT_PREFIX=“marmarek/qubes-” to use marmarek’s repo instead of “mainstream” - it contains newer (but less tested) versions + - You can also set GIT_PREFIX=“marmarek/qubes-” to use marmarek’s repo instead of “mainstream” - it contains newer (but less tested) versions diff --git a/developer/code/code-signing.rst b/developer/code/code-signing.rst index b27d91d9..e716d493 100644 --- a/developer/code/code-signing.rst +++ b/developer/code/code-signing.rst @@ -111,6 +111,7 @@ If you’re submitting a patch via GitHub (or a similar Git server), please sign 3. (Optional) Create signed tags. Signed commits are totally sufficient to contribute to Qubes OS. However, if you have commits which are not signed and you do not want to change them, you can create a signed tag for the commit and push it before the check. + This is useful for example, if you have a commit back in the git history which you like to sign now without rewriting the history. .. code:: bash diff --git a/developer/code/coding-style.rst b/developer/code/coding-style.rst index d8f5f3cb..759dacea 100644 --- a/developer/code/coding-style.rst +++ b/developer/code/coding-style.rst @@ -49,7 +49,7 @@ General typographic conventions - **Maintain a decent amount of horizontal spacing**, e.g. add a space after ``if`` or before ``{`` in C, and similar in other languages. Whether and where to also use spaces within expressions, such as (x*2+5) vs. (x * 2 + 5) is left to the developer’s judgment. Do not put spaces immediately after or before the brackets in expressions, so avoid constructs like this: ``if ( condition )`` and use ones like this: ``if (condition)`` instead. -- **Use single new lines** (‘\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs. +- **Use single new lines** (‘\\n’ aka LF) in any non-Windows source code. On Windows, exceptionally, use the CRLF line endings (–). This will allow the source code to be easily viewable in various Windows-based programs. - **Use descriptive names for variables and functions**! Really, at a time when most editors have auto-completion features, there is no excuse for using short variable names. diff --git a/developer/code/source-code.rst b/developer/code/source-code.rst index 7765a2fc..ae3ec0ce 100644 --- a/developer/code/source-code.rst +++ b/developer/code/source-code.rst @@ -61,6 +61,7 @@ How to Send Patches If you want to :ref:`contribute code ` to the project, there are two ways. Whichever method you choose, you must :doc:`sign your code ` before it can be accepted. - **Preferred**: Use GitHub’s `fork & pull requests `__. + Opening a pull request on GitHub greatly eases the code review and tracking process. In addition, especially for bigger changes, it’s a good idea to send a message to the :ref:`qubes-devel mailing list ` in order to notify people who do not receive GitHub notifications. - Send a patch to the :ref:`qubes-devel mailing list ` (``git format-patch``). diff --git a/developer/debugging/vm-interface.rst b/developer/debugging/vm-interface.rst index 7864d6c8..87523cc8 100644 --- a/developer/debugging/vm-interface.rst +++ b/developer/debugging/vm-interface.rst @@ -199,11 +199,11 @@ Services called by dom0 to provide some VM configuration: - - ``xdgicon:NAME`` - search for NAME in standard icons theme + - ``xdgicon:NAME`` - search for NAME in standard icons theme - - ``-`` - get icon data from stdin (the caller), can be prefixed with format name, for example ``png:-`` + - ``-`` - get icon data from stdin (the caller), can be prefixed with format name, for example ``png:-`` - - file name + - file name diff --git a/developer/general/usability-ux.rst b/developer/general/usability-ux.rst index da9baacf..50dd8c13 100644 --- a/developer/general/usability-ux.rst +++ b/developer/general/usability-ux.rst @@ -225,13 +225,13 @@ There are many cases where a user wants to perform an action on more than one fi -- Click Folder One + - Click Folder One -- Click Folder Two + - Click Folder Two -- Click Folder Three + - Click Folder Three -- Click Folder Four + - Click Folder Four @@ -304,4 +304,4 @@ Learning to make well designing intuitive interfaces and software is specialized .. |checkmark| image:: /attachment/doc/checkmark.png -.. |redx| image:: /attachment/doc/red_x.png \ No newline at end of file +.. |redx| image:: /attachment/doc/red_x.png diff --git a/developer/releases/4_0/release-notes.rst b/developer/releases/4_0/release-notes.rst index 95e82452..47bfb60c 100644 --- a/developer/releases/4_0/release-notes.rst +++ b/developer/releases/4_0/release-notes.rst @@ -56,6 +56,7 @@ Security Notes - PV VMs migrated from 3.2 to 4.0-rc4 or later are automatically set to PVH mode in order to protect against Meltdown (see `QSB #37 `__). However, PV VMs migrated from any earlier 4.0 release candidate (RC1, RC2, or RC3) are not automatically set to PVH mode. These must be set manually. - The following steps may need to be applied in dom0 and Fedora 26 TemplateVMs in order to receive updates (see `#3737 `__). + Steps for dom0 updates: 1. Open the Qubes Menu by clicking on the “Q” icon in the top-left corner of the screen. diff --git a/developer/services/admin-api.rst b/developer/services/admin-api.rst index 03964deb..7727bb09 100644 --- a/developer/services/admin-api.rst +++ b/developer/services/admin-api.rst @@ -152,11 +152,11 @@ it easy to set the policy using current mechanism. - ``dom0`` - `-` - `-` - - `` `` + - `` \n`` - Get all the properties in one call. Each property is returned on a separate line and use the same value encoding as property.Get method, with an exception that newlines are encoded as literal ``\n`` and literal ``\`` are encoded as ``\\``. * - ``admin.property.GetDefault`` - ``dom0`` - - propety + - property - `-` - ``type={str|int|bool|vm|label|list} `` - Type ``list`` is added in R4.1. Values are of type ``str`` and each entry is suffixed with newline character. @@ -339,13 +339,7 @@ it easy to set the policy using current mechanism. - device - assignment-serialization - `-` - - ``device`` is in form ``+`` optional options given in ``key=value`` format, separated with spaces; options can include ``persistent=True`` to "persistently" attach the device (default is temporary) - * - ``admin.vm.device..Detach`` - - vm - - device - - `-` - - `-` - - ``device`` is in form ``+`` + - ``device`` is in form ``+``; optional options given in ``key=value`` format, separated with spaces; options can include ``persistent=True`` to "persistently" attach the device (default is temporary) * - ``admin.vm.device..Detach`` - vm - device @@ -355,9 +349,9 @@ it easy to set the policy using current mechanism. * - ``admin.vm.device..Assign`` - vm - device - - assignement-serialization + - assignment-serialization - `-` - - ``device`` is in form ``+`` ``assignment-serialization`` is specified in the section Device Serialization. + - ``device`` is in form ``+``; ``assignment-serialization`` is specified in the section Device Serialization. * - ``admin.vm.device..Unassign`` - vm - device @@ -371,7 +365,7 @@ it easy to set the policy using current mechanism. - `-` - ``device`` is in form ``+`` * - ``admin.vm.deviceclass.List`` - - `dom0` + - ``dom0`` - `-` - `-` - ``\n`` @@ -387,7 +381,7 @@ it easy to set the policy using current mechanism. - device-ident - `-` - `` \n`` - - optional service argument may be used to get info about a single device, ``assignement-serialization`` is specified in the section Device Serialization. + - optional service argument may be used to get info about a single device, ``assignment-serialization`` is specified in the section Device Serialization. * - ``admin.vm.device..Attached`` - vm - device-ident @@ -410,7 +404,7 @@ it easy to set the policy using current mechanism. - ``dom0`` - pool - `-` - - ``=`` + - ``=\n`` - * - ``admin.pool.Add`` - ``dom0`` @@ -566,7 +560,7 @@ it easy to set the policy using current mechanism. - vm - `-` - `-` - - ``=`` + - ``=\n`` - state properties: ``power_state``, ``mem``, ``mem_static_max``, ``cputime`` * - ``admin.vm.Start`` - vm diff --git a/developer/services/qrexec.rst b/developer/services/qrexec.rst index 0ae67f06..be623ab2 100644 --- a/developer/services/qrexec.rst +++ b/developer/services/qrexec.rst @@ -113,7 +113,10 @@ Answering an RPC call ^^^^^^^^^^^^^^^^^^^^^ -In other for a RPC call to be answered in the target VM, a file in either of the following locations must exist, containing the file name of the program that will be invoked, or being that program itself – in which case it must have executable permission set (``chmod +x``): - ``/etc/qubes-rpc/RPC_ACTION_NAME`` when you make it in the template qube; - ``/usr/local/etc/qubes-rpc/RPC_ACTION_NAME`` for making it only in an app qube. +In other for a RPC call to be answered in the target VM, a file in either of the following locations must exist, containing the file name of the program that will be invoked, or being that program itself – in which case it must have executable permission set (``chmod +x``): + + - ``/etc/qubes-rpc/RPC_ACTION_NAME`` when you make it in the template qube; + - ``/usr/local/etc/qubes-rpc/RPC_ACTION_NAME`` for making it only in an app qube. The source VM name can then be accessed in the server process via ``QREXEC_REMOTE_DOMAIN`` environment variable. (Note the source VM has *no* control over the name provided in this variable–the name of the VM is provided by dom0, and so is trusted.) diff --git a/introduction/intro.rst b/introduction/intro.rst index adbf4f26..0d05fb99 100644 --- a/introduction/intro.rst +++ b/introduction/intro.rst @@ -6,7 +6,7 @@ What is Qubes OS? ----------------- Qubes OS is a free and open-source, security-oriented operating system for -single-user desktop computing. Qubes OS `leverages Xen-based virtualization `__ to allow for the creation and management of isolated compartments called :ref:`qubes `. +single-user desktop computing. Qubes OS leverages `Xen-based virtualization `__ to allow for the creation and management of isolated compartments called :ref:`qubes `. These qubes, which are implemented as :ref:`virtual machines (VMs)`, have specific: diff --git a/user/advanced-topics/kde.rst b/user/advanced-topics/kde.rst index 8142f6e9..0b49e734 100644 --- a/user/advanced-topics/kde.rst +++ b/user/advanced-topics/kde.rst @@ -82,7 +82,7 @@ Window Management You can set each window’s position and size like this: -.. code:: python +.. code:: text Right click title bar --> More actions --> Special window settings... diff --git a/user/advanced-topics/managing-vm-kernels.rst b/user/advanced-topics/managing-vm-kernels.rst index e1f83b51..cb4f28eb 100644 --- a/user/advanced-topics/managing-vm-kernels.rst +++ b/user/advanced-topics/managing-vm-kernels.rst @@ -22,7 +22,7 @@ By default, VMs kernels are provided by dom0. (See :ref:`here Building files for 4.1.9-6.pvops.qubes.x86_64 in /var/lib/qubes/vm-kernels/4.1.qubes @@ -244,7 +244,7 @@ Using kernel installed in the VM Both debian-9 and fedora-26 templates already have grub and related tools preinstalled so if you want to use one of the distribution kernels, all you need to do is clone either template to a new one, then: -.. code:: bash +.. code:: console qvm-prefs virt_mode hvm qvm-prefs kernel '' @@ -261,7 +261,7 @@ Install whatever kernel you want. You need to also ensure you have the ``kernel- If you are using a distribution kernel package (``kernel`` package), the initramfs and kernel modules may be handled automatically. If you are using a manually built kernel, you need to handle this on your own. Take a look at the ``dkms`` documentation, especially the ``dkms autoinstall`` command may be useful. If you did not see the ``kernel`` install rebuild your initramfs, or are using a manually built kernel, you will need to rebuild it yourself. Replace the version numbers in the example below with the ones appropriate to the kernel you are installing: -.. code:: bash +.. code:: console sudo dracut -f /boot/initramfs-4.15.14-200.fc26.x86_64.img 4.15.14-200.fc26.x86_64 @@ -269,7 +269,7 @@ If you are using a distribution kernel package (``kernel`` package), the initram Once the kernel is installed, you need to setup ``grub2`` by running: -.. code:: bash +.. code:: console sudo grub2-install /dev/xvda @@ -277,7 +277,7 @@ Once the kernel is installed, you need to setup ``grub2`` by running: Finally, you need to create a GRUB configuration. You may want to adjust some settings in ``/etc/default/grub``; for example, lower ``GRUB_TIMEOUT`` to speed up VM startup. Then, you need to generate the actual configuration. In Fedora it can be done using the ``grub2-mkconfig`` tool: -.. code:: bash +.. code:: console sudo grub2-mkconfig -o /boot/grub2/grub.cfg @@ -285,7 +285,7 @@ Finally, you need to create a GRUB configuration. You may want to adjust some se You can safely ignore this error message: -.. code:: bash +.. code:: output grub2-probe: error: cannot find a GRUB drive for /dev/mapper/dmroot. Check your device.map @@ -319,7 +319,7 @@ Using a distribution kernel package the initramfs and kernel modules should be h Install distribution kernel image, kernel headers and the grub. -.. code:: bash +.. code:: console sudo apt install linux-image-amd64 linux-headers-amd64 grub2 qubes-kernel-vm-support @@ -327,7 +327,7 @@ Install distribution kernel image, kernel headers and the grub. If you are doing that on a qube based on “Debian Minimal” template, a grub gui will popup during the installation, asking you where you want to install the grub loader. You must select ``/dev/xvda`` (check the box using the space bar, and validate your choice with “Enter”.) If this popup does not appear during the installation, you must manually setup ``grub2`` by running: -.. code:: bash +.. code:: console sudo grub-install /dev/xvda @@ -381,7 +381,7 @@ Run DKMS. Replace this with actual kernel version. -.. code:: bash +.. code:: console sudo dkms autoinstall -k @@ -390,7 +390,7 @@ For example. -.. code:: bash +.. code:: console sudo dkms autoinstall -k 4.19.0-6-amd64 @@ -399,14 +399,14 @@ Update initramfs. -.. code:: bash +.. code:: console sudo update-initramfs -u The output should look like this: -.. code:: bash +.. code:: text $ sudo dkms autoinstall -k 3.16.0-4-amd64 diff --git a/user/advanced-topics/salt.rst b/user/advanced-topics/salt.rst index 27baac14..7ce4d22b 100644 --- a/user/advanced-topics/salt.rst +++ b/user/advanced-topics/salt.rst @@ -349,7 +349,7 @@ As in the example above, it creates a qube and sets its properties. You can set properties of an existing qube: -.. code:: bash +.. code:: text my preferences: qvm.prefs: @@ -364,7 +364,7 @@ You can set properties of an existing qube: ^^^^^^^^^^^^^^^ -.. code:: bash +.. code:: text services in my qube: qvm.service: @@ -388,7 +388,7 @@ This enables, disables, or sets to default, services as in ``qvm-service``. Ensures the specified qube is running: -.. code:: bash +.. code:: text qube is running: qvm.running: diff --git a/user/advanced-topics/secondary-storage.rst b/user/advanced-topics/secondary-storage.rst index a1357ecd..30d69f89 100644 --- a/user/advanced-topics/secondary-storage.rst +++ b/user/advanced-topics/secondary-storage.rst @@ -20,14 +20,14 @@ Qubes 4.0 is more flexible than earlier versions about placing different VMs on You can query qvm-pool to list available storage drivers: -.. code:: bash +.. code:: console qvm-pool --help-drivers qvm-pool driver explanation: -.. code:: bash +.. code:: text refers to using a simple file for image storage and lacks a few features. refers to storing images on a filesystem supporting copy on write. diff --git a/user/downloading-installing-upgrading/upgrade/4_1.rst b/user/downloading-installing-upgrading/upgrade/4_1.rst index 7f34240d..f90104f1 100644 --- a/user/downloading-installing-upgrading/upgrade/4_1.rst +++ b/user/downloading-installing-upgrading/upgrade/4_1.rst @@ -37,7 +37,7 @@ The upgrade may take several hours, and will download several gigabytes of data. In place upgrade is a complex operation. For this reason, we provide a ``qubes-dist-upgrade`` tool to handle all the necessary steps automatically. You can install it with the following command in the dom0 terminal: -.. code:: bash +.. code:: console sudo qubes-dom0-update -y qubes-dist-upgrade @@ -47,7 +47,7 @@ The upgrade consists of seven stages — six before restarting the system — la Full list of options can be obtained with ``qubes-dist-upgrade --help``: -.. code:: bash +.. code:: output Usage: qubes-dist-upgrade [OPTIONS]... @@ -82,7 +82,7 @@ Full list of options can be obtained with ``qubes-dist-upgrade --help``: After installing the tool, upgrade can be performed all at once with: -.. code:: bash +.. code:: console sudo qubes-dist-upgrade --all @@ -94,7 +94,7 @@ Alternatively, each upgrade stage can be started separately (see the list of opt After completing “STAGE 0” through “STAGE 5”, restart the system. Then perform the final step: -.. code:: bash +.. code:: console sudo qubes-dist-upgrade --resync-appmenus-features diff --git a/user/downloading-installing-upgrading/upgrade/4_2.rst b/user/downloading-installing-upgrading/upgrade/4_2.rst index 3802df12..58a98e15 100644 --- a/user/downloading-installing-upgrading/upgrade/4_2.rst +++ b/user/downloading-installing-upgrading/upgrade/4_2.rst @@ -56,7 +56,7 @@ The upgrade may take several hours, and will download several gigabytes of data. In place upgrade is a complex operation. For this reason, we provide a ``qubes-dist-upgrade`` tool to handle all the necessary steps automatically. You can install it with the following command in the dom0 terminal: -.. code:: bash +.. code:: console sudo qubes-dom0-update -y qubes-dist-upgrade @@ -66,7 +66,7 @@ The upgrade consists of six stages — three before restarting the system — la Full list of options can be obtained with ``qubes-dist-upgrade --help``: -.. code:: bash +.. code:: output Usage: qubes-dist-upgrade [OPTIONS]... @@ -102,7 +102,7 @@ Full list of options can be obtained with ``qubes-dist-upgrade --help``: After installing the tool, before-reboot stages can be performed at once with: -.. code:: bash +.. code:: console sudo qubes-dist-upgrade --all-pre-reboot @@ -114,7 +114,7 @@ Alternatively, each upgrade stage can be started separately (see the list of opt After completing “STAGE 1” through “STAGE 3”, restart the system. Then perform the final steps: -.. code:: bash +.. code:: console sudo qubes-dist-upgrade --all-post-reboot diff --git a/user/hardware/certified-hardware/certified-hardware.rst b/user/hardware/certified-hardware/certified-hardware.rst index 8486cbbd..b07e03f2 100644 --- a/user/hardware/certified-hardware/certified-hardware.rst +++ b/user/hardware/certified-hardware/certified-hardware.rst @@ -35,7 +35,7 @@ The current Qubes-certified models are listed below in reverse chronological ord - :doc:`Certification details ` * - `NovaCustom `__ - `V56 Series `__ - - :doc:`Certification details ` + - :doc:`Certification details ` * - `Nitrokey `__ - `NitroPC Pro 2 `__ - :doc:`Certification details ` @@ -55,7 +55,7 @@ The current Qubes-certified models are listed below in reverse chronological ord - `NitroPad T430 `__ - :doc:`Certification details ` * - `Nitrokey `__ - - `NitroPad X230 `__ + - `NitroPad X230 `__ - :doc:`Certification details ` * - `Insurgo `__ - `PrivacyBeast X230 `__ diff --git a/user/templates/templates.rst b/user/templates/templates.rst index 941690d3..eb03620b 100644 --- a/user/templates/templates.rst +++ b/user/templates/templates.rst @@ -201,6 +201,7 @@ When you install a new template or :ref:`upgrade `, or that USB qube is *not* a disposable, then shut down all disposables. In the App Menu, go to Qubes Tools, then click on Qube Manager. In the Qube Manager, find your disposable template(s). (By default, they end in ``-dvm``.) Right click, hover over Template, then click on the new template. Repeat for each disposable template. - If your only keyboard or mouse *are* connected through a USB qube, and that USB qube *is* a disposable, then you will have to enter a special command that shuts down all of your qubes, switches the USB qube’s disposable template to the new template, then starts the USB qube again. In order to avoid being locked out of your system, you must be very careful to enter this command without typos and with the correct substitutions. + In the App Menu, click on Terminal Emulator. Type the command below, substituting ```` with the name of the disposable template on which ``sys-usb`` is based, ```` with the name of the new template, and ```` with the name of your USB qube. Other than these substitutions, make sure to enter the command exactly as written. .. code:: bash @@ -249,7 +250,7 @@ Once an app qube has been created, any changes in its ``/home``, ``/usr/local``, * - :ref:`template ` - N/A (templates cannot be based on templates) - everything - * - :ref:`app qubes `:superscript:`3` + * - :ref:`app qube `:superscript:`3` - ``/etc/skel`` to ``/home``; ``/usr/local.orig`` to ``/usr/local`` - ``/rw`` (includes ``/home``, ``/usr/local``, and ``bind-dirs``) * - :ref:`disposable ` diff --git a/user/templates/windows/qubes-windows-tools-4-0.rst b/user/templates/windows/qubes-windows-tools-4-0.rst index e50ed0b2..bfce9b69 100644 --- a/user/templates/windows/qubes-windows-tools-4-0.rst +++ b/user/templates/windows/qubes-windows-tools-4-0.rst @@ -143,7 +143,7 @@ This will allow you to install the Qubes Windows Tools on Windows 10 both as a S **Note:** If this property is not set or set to a wrong value, files copied to this VM are stored in the folder -.. code:: bash +.. code:: text C:\Windows\System32\config\systemprofile\Documents\QubesIncoming\ @@ -507,9 +507,9 @@ If a specific component is malfunctioning, you can increase its log verbosity as * - network-setup - Service that sets up network parameters according to VM’s configuration. * - prepare-volume - - Utility that initializes and formats the disk backed by private.img file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot. + - Utility that initializes and formats the disk backed by ``private.img`` file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot. * - relocate-dir - - Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: c:\move-profiles.log (it can’t use our common logger library so none of the log settings apply). + - Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``c:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply). diff --git a/user/templates/windows/qubes-windows-tools-4-1.rst b/user/templates/windows/qubes-windows-tools-4-1.rst index 291d6a31..e0b662ad 100644 --- a/user/templates/windows/qubes-windows-tools-4-1.rst +++ b/user/templates/windows/qubes-windows-tools-4-1.rst @@ -536,9 +536,9 @@ If a specific component is malfunctioning, you can increase its log verbosity as * - network-setup - Service that sets up network parameters according to VM’s configuration. * - prepare-volume - - Utility that initializes and formats the disk backed by private.img file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot. + - Utility that initializes and formats the disk backed by ``private.img`` file. It’s registered to run on next system boot during QWT setup, if that feature is selected (it can’t run during the setup because Xen block device drivers are not yet active). It in turn registers move-profiles (see below) to run at early boot. * - relocate-dir - - Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: C:\\move-profiles.log (it can’t use our common logger library so none of the log settings apply). + - Utility that moves user profiles directory to the private disk. It’s registered as an early boot native executable (similar to chkdsk) so it can run before any profile files are opened by some other process. Its log is in a fixed location: ``C:\move-profiles.log`` (it can’t use our common logger library so none of the log settings apply). diff --git a/user/templates/windows/windows-qubes-4-0.rst b/user/templates/windows/windows-qubes-4-0.rst index 489a8c11..11c30615 100644 --- a/user/templates/windows/windows-qubes-4-0.rst +++ b/user/templates/windows/windows-qubes-4-0.rst @@ -100,8 +100,11 @@ Installation procedure: - Install on first disk. - Windows license may be read from flash via root in dom0: + ``strings < /sys/firmware/acpi/tables/MSDM`` + Alternatively, you can also try a Windows 7 license key (as of 2018/11 they are still accepted for a free upgrade). + I first installed Windows and all updates, then entered the license key. diff --git a/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst b/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst index b1d3a77e..d68525ac 100644 --- a/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst +++ b/user/troubleshooting/debian-and-whonix-update-troubleshooting.rst @@ -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:: +.. code:: text 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:: +.. code:: text 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:: +.. code:: text Setting up ifupdown ... Configuration file /etc/network/interfaces diff --git a/user/troubleshooting/gui-troubleshooting.rst b/user/troubleshooting/gui-troubleshooting.rst index 01f65d14..2703c96e 100644 --- a/user/troubleshooting/gui-troubleshooting.rst +++ b/user/troubleshooting/gui-troubleshooting.rst @@ -13,7 +13,7 @@ When a qube starts, a fixed amount of RAM is allocated to the graphics buffer ca To determine if this is the problem affecting you, look at the Xorg log inside the Qube at ``/home/user/.local/share/xorg/Xorg.0.log`` for lines like the following: -.. code:: bash +.. code:: text [ 1623.988] (EE) DUMMYQBS(0): Unable to set up a virtual screen size of 3440x1440 with 17101 Kb of video memory available. Please increase the video memory size. diff --git a/user/troubleshooting/uefi-troubleshooting.rst b/user/troubleshooting/uefi-troubleshooting.rst index 05a05d7a..fdfd0dea 100644 --- a/user/troubleshooting/uefi-troubleshooting.rst +++ b/user/troubleshooting/uefi-troubleshooting.rst @@ -81,7 +81,24 @@ Or if you have already rebooted after the first stage install and have encounter 2. Press ‘3’ to go to the shell -3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): ``fdisk -l /dev/sda | grep EFI`` The output should look like this: ``/dev/sda1 2048 1230847 1228800 600M EFI System`` Then mount it: ``mkdir -p /mnt/sysimage/boot/efi mount /dev/sda1 /mnt/sysimage/boot/efi`` +3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): + + .. code:: console + + fdisk -l /dev/sda | grep EFI + + The output should look like this: + + .. code:: output + + /dev/sda1 2048 1230847 1228800 600M EFI System + + Then mount it: + + .. code:: console + + mkdir -p /mnt/sysimage/boot/efi + mount /dev/sda1 /mnt/sysimage/boot/efi 4. Execute: @@ -107,7 +124,24 @@ Some firmware will not recognize the default Qubes EFI configuration. As such, i 2. Press ‘3’ to go to the shell -3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): ``fdisk -l /dev/sda | grep EFI`` The output should look like this: ``/dev/sda1 2048 1230847 1228800 600M EFI System`` Then mount it: ``mkdir -p /mnt/sysimage/boot/efi mount /dev/sda1 /mnt/sysimage/boot/efi`` +3. Find and mount the EFI system partition. (replace ``/dev/sda`` with your disk name. If unsure, use the ``lsblk`` command to display a list of disks): + + .. code:: console + + fdisk -l /dev/sda | grep EFI + + The output should look like this: + + .. code:: output + + /dev/sda1 2048 1230847 1228800 600M EFI System + + Then mount it: + + .. code:: console + + mkdir -p /mnt/sysimage/boot/efi + mount /dev/sda1 /mnt/sysimage/boot/efi 4. Copy ``grubx64.efi`` to the fallback path: diff --git a/user/troubleshooting/vm-troubleshooting.rst b/user/troubleshooting/vm-troubleshooting.rst index e8c7cf76..91d7210b 100644 --- a/user/troubleshooting/vm-troubleshooting.rst +++ b/user/troubleshooting/vm-troubleshooting.rst @@ -73,7 +73,7 @@ Some packages will throw an error on installation in this situation. For example One solution is to add a dummy interface to allow the package to install correctly: -.. code:: bash +.. code:: console ip link add d0 type dummy ip addr add 192.168.0.1/24 dev d0 @@ -95,7 +95,7 @@ If the error occurs as a result of too little initial memory, increase the initi For example: -.. code:: bash +.. code:: text [user@dom0 ~]$ sudo qubes-dom0-update --enablerepo=qubes-templates-itl qubes-template-debian-10 Using sys-whonix as UpdateVM to download updates for Dom0; this may take some time...