From ca2b5312d8b46148606d875b007e46b2593f8179 Mon Sep 17 00:00:00 2001 From: Randy <177127055+RandyTheOtter@users.noreply.github.com> Date: Sun, 26 Oct 2025 16:00:14 +0000 Subject: [PATCH 1/4] how-to-update.rst : Add examples 1. Add CLI tools usage examples and references to documentation 2. Minor styling in Command-line interface section: make writing a bit more concise, use numbered nested list --- user/how-to-guides/how-to-update.rst | 23 +++++++++++++++++++---- 1 file changed, 19 insertions(+), 4 deletions(-) diff --git a/user/how-to-guides/how-to-update.rst b/user/how-to-guides/how-to-update.rst index a09a68f8..6564618b 100644 --- a/user/how-to-guides/how-to-update.rst +++ b/user/how-to-guides/how-to-update.rst @@ -87,14 +87,29 @@ Command-line interface Advanced users may wish to perform updates via the command-line interface. There are two ways to do this: -- If you are using Salt, one can use the following two Salt states. +1. Use the following two Salt states: -- :ref:`update.qubes-dom0 ` + - :ref:`update.qubes-dom0 ` -- :ref:`update.qubes-vm ` + - :ref:`update.qubes-vm ` -- Alternatively, use ``qubes-dom0-update`` to update dom0, and use ``qubes-vm-update`` to update domUs. +2. Use ``qubes-dom0-update`` to update dom0, and use ``qubes-vm-update`` to update domUs: + - Execute ``sudo qubes-dom0-update`` to check for updates and apply them or add arguments to tweak the behavior. Refer to: + + - ``qubes-dom0-update --help`` + + - ``man qubes-dom0-update`` (if you have documentation installed) + + - `manual on github `__ (make sure to read the appropriate version) + + - Execute ``qubes-vm-update -T`` to update all templates with available updates or use a different set of arguments. Refer to: + + - ``qubes-vm-update --help`` + + - ``man qubes-vm-update`` (if you have documentation installed) + + - `manual on github `__ (make sure to read the appropriate version) Using either of these methods has the same effect as updating via the Qubes Update tool. From 862d5be63f0ab6b33c1623eace2921d44a00773b Mon Sep 17 00:00:00 2001 From: Randy <177127055+RandyTheOtter@users.noreply.github.com> Date: Tue, 28 Oct 2025 12:10:40 +0000 Subject: [PATCH 2/4] how-to-update.rst : try adding code block inside nested list Add code block inside nested list and collapse the highest level to make the article a bit shorter --- user/how-to-guides/how-to-update.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/user/how-to-guides/how-to-update.rst b/user/how-to-guides/how-to-update.rst index 6564618b..aed5c0d0 100644 --- a/user/how-to-guides/how-to-update.rst +++ b/user/how-to-guides/how-to-update.rst @@ -95,22 +95,21 @@ Advanced users may wish to perform updates via the command-line interface. There 2. Use ``qubes-dom0-update`` to update dom0, and use ``qubes-vm-update`` to update domUs: - - Execute ``sudo qubes-dom0-update`` to check for updates and apply them or add arguments to tweak the behavior. Refer to: + - To check for dom0 updates and apply them, execute - - ``qubes-dom0-update --help`` + .. code:: console - - ``man qubes-dom0-update`` (if you have documentation installed) + # qubes-dom0-update - - `manual on github `__ (make sure to read the appropriate version) + Or add arguments to tweak the default behaviour. Refer to ``qubes-dom0-update --help``, manpage (if you have them installed) or `manpage on github `__ (make sure to read the appropriate version). - - Execute ``qubes-vm-update -T`` to update all templates with available updates or use a different set of arguments. Refer to: + - To update all updatable templates, execute - - ``qubes-vm-update --help`` + .. code:: console - - ``man qubes-vm-update`` (if you have documentation installed) - - - `manual on github `__ (make sure to read the appropriate version) + $ qubes-vm-update -T + Or use a different set of arguments. Refer to ``qubes-vm-update --help``, manpage (if you have them installed) or `manpage on github `__ (make sure to read the appropriate version). Using either of these methods has the same effect as updating via the Qubes Update tool. From a1beee7676109c3f17967e11d309a8e42a4d765b Mon Sep 17 00:00:00 2001 From: Randy <177127055+RandyTheOtter@users.noreply.github.com> Date: Tue, 28 Oct 2025 12:38:49 +0000 Subject: [PATCH 3/4] how-to-update.rst : tell to run the commands in dom0 terminal --- user/how-to-guides/how-to-update.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user/how-to-guides/how-to-update.rst b/user/how-to-guides/how-to-update.rst index aed5c0d0..f68dbdab 100644 --- a/user/how-to-guides/how-to-update.rst +++ b/user/how-to-guides/how-to-update.rst @@ -95,7 +95,7 @@ Advanced users may wish to perform updates via the command-line interface. There 2. Use ``qubes-dom0-update`` to update dom0, and use ``qubes-vm-update`` to update domUs: - - To check for dom0 updates and apply them, execute + - To check for dom0 updates and apply them, in a dom0 terminal: .. code:: console @@ -103,7 +103,7 @@ Advanced users may wish to perform updates via the command-line interface. There Or add arguments to tweak the default behaviour. Refer to ``qubes-dom0-update --help``, manpage (if you have them installed) or `manpage on github `__ (make sure to read the appropriate version). - - To update all updatable templates, execute + - To update all updatable templates, in a dom0 terminal: .. code:: console From ac5bbea8c74605d3832735ff39364611d1ad0d76 Mon Sep 17 00:00:00 2001 From: Randy <177127055+RandyTheOtter@users.noreply.github.com> Date: Wed, 29 Oct 2025 13:08:14 +0000 Subject: [PATCH 4/4] how-to-update.rst : use `man` instead of manpage Tell the command, not the word --- user/how-to-guides/how-to-update.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/user/how-to-guides/how-to-update.rst b/user/how-to-guides/how-to-update.rst index f68dbdab..eef5bb66 100644 --- a/user/how-to-guides/how-to-update.rst +++ b/user/how-to-guides/how-to-update.rst @@ -101,7 +101,7 @@ Advanced users may wish to perform updates via the command-line interface. There # qubes-dom0-update - Or add arguments to tweak the default behaviour. Refer to ``qubes-dom0-update --help``, manpage (if you have them installed) or `manpage on github `__ (make sure to read the appropriate version). + Or add arguments to tweak the default behaviour. Refer to ``qubes-dom0-update --help``, ``man qubes-dom0-update`` or `manpage on github `__ (make sure to read the appropriate version). - To update all updatable templates, in a dom0 terminal: @@ -109,7 +109,7 @@ Advanced users may wish to perform updates via the command-line interface. There $ qubes-vm-update -T - Or use a different set of arguments. Refer to ``qubes-vm-update --help``, manpage (if you have them installed) or `manpage on github `__ (make sure to read the appropriate version). + Or use a different set of arguments. Refer to ``qubes-vm-update --help``, ``man qubes-vm-update`` or `manpage on github `__ (make sure to read the appropriate version). Using either of these methods has the same effect as updating via the Qubes Update tool.