Fix formattings and other issues

See issue 8180.
This commit is contained in:
Tobias Killer 2025-08-09 09:50:36 +02:00
parent 810901e5d6
commit 0cfd755295
25 changed files with 114 additions and 76 deletions

View file

@ -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 marmareks repo instead of “mainstream” - it contains newer (but less tested) versions
- You can also set GIT_PREFIX=“marmarek/qubes-” to use marmareks repo instead of “mainstream” - it contains newer (but less tested) versions

View file

@ -111,6 +111,7 @@ If youre 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

View file

@ -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 developers 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.

View file

@ -61,6 +61,7 @@ How to Send Patches
If you want to :ref:`contribute code <introduction/contributing:contributing code>` to the project, there are two ways. Whichever method you choose, you must :doc:`sign your code </developer/code/code-signing>` before it can be accepted.
- **Preferred**: Use GitHubs `fork & pull requests <https://guides.github.com/activities/forking/>`__.
Opening a pull request on GitHub greatly eases the code review and tracking process. In addition, especially for bigger changes, its a good idea to send a message to the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>` in order to notify people who do not receive GitHub notifications.
- Send a patch to the :ref:`qubes-devel mailing list <introduction/support:qubes-devel>` (``git format-patch``).

View file

@ -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

View file

@ -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
.. |redx| image:: /attachment/doc/red_x.png

View file

@ -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 <https://github.com/QubesOS/qubes-secpack/blob/master/QSBs/qsb-037-2018.txt>`__). 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 <https://github.com/QubesOS/qubes-issues/issues/3737>`__).
Steps for dom0 updates:
1. Open the Qubes Menu by clicking on the “Q” icon in the top-left corner of the screen.

View file

@ -152,11 +152,11 @@ it easy to set the policy using current mechanism.
- ``dom0``
- `-`
- `-`
- ``<property-name> <full-value-as-in-property.Get>``
- ``<property-name> <full-value-as-in-property.Get>\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} <value>``
- 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 ``<backend-name>+<device-ident>`` 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.<class>.Detach``
- vm
- device
- `-`
- `-`
- ``device`` is in form ``<backend-name>+<device-ident>``
- ``device`` is in form ``<backend-name>+<device-ident>``; 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.<class>.Detach``
- vm
- device
@ -355,9 +349,9 @@ it easy to set the policy using current mechanism.
* - ``admin.vm.device.<class>.Assign``
- vm
- device
- assignement-serialization
- assignment-serialization
- `-`
- ``device`` is in form ``<backend-name>+<device-ident>`` ``assignment-serialization`` is specified in the section Device Serialization.
- ``device`` is in form ``<backend-name>+<device-ident>``; ``assignment-serialization`` is specified in the section Device Serialization.
* - ``admin.vm.device.<class>.Unassign``
- vm
- device
@ -371,7 +365,7 @@ it easy to set the policy using current mechanism.
- `-`
- ``device`` is in form ``<backend-name>+<device-ident>``
* - ``admin.vm.deviceclass.List``
- `dom0`
- ``dom0``
- `-`
- `-`
- ``<deviceclass>\n``
@ -387,7 +381,7 @@ it easy to set the policy using current mechanism.
- device-ident
- `-`
- ``<device-ident> <assignment-serialization>\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.<class>.Attached``
- vm
- device-ident
@ -410,7 +404,7 @@ it easy to set the policy using current mechanism.
- ``dom0``
- pool
- `-`
- ``<property>=<value>``
- ``<property>=<value>\n``
-
* - ``admin.pool.Add``
- ``dom0``
@ -566,7 +560,7 @@ it easy to set the policy using current mechanism.
- vm
- `-`
- `-`
- ``<state-property>=<value>``
- ``<state-property>=<value>\n``
- state properties: ``power_state``, ``mem``, ``mem_static_max``, ``cputime``
* - ``admin.vm.Start``
- vm

View file

@ -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 variablethe name of the VM is provided by dom0, and so is trusted.)