From 61850fa214a6a9002946cc98b032682cc2d014a2 Mon Sep 17 00:00:00 2001
From: Walter Lozano <walter.lozano@collabora.com>
Date: Thu, 21 Jan 2021 20:52:08 +0000
Subject: [PATCH] Fix formatting in ostree guide
Fix some formatting issues, remarks and command names.
Signed-off-by: Walter Lozano <walter.lozano@collabora.com>
---
content/guides/ostree.md | 28 ++++++++++++++--------------
1 file changed, 14 insertions(+), 14 deletions(-)
diff --git a/content/guides/ostree.md b/content/guides/ostree.md
index 2b2e00fdd..3e540482a 100644
--- a/content/guides/ostree.md
+++ b/content/guides/ostree.md
@@ -19,22 +19,22 @@ With the 18.03 release of Apertis, a new set of images have appeared.
Apertis is now delivered in two variants: apt images and OSTree images.
The standard images are a debian derivative. The OSTree images are
-prefixed \`apertis_ostree\`. There is no OSTree images for the SDK. The
+prefixed `apertis_ostree`. There is no OSTree images for the SDK. The
SDK includes a tool for creating or manipulating OSTree repositories,
but it is not using OSTree as a way to update itself. Only OSTree
specific images will support OSTree commands for updates and rollback.
-Note that \`apt-get\` and the debian packages are not available in
+Note that `apt-get` and the debian packages are not available in
OSTree images.
# Updating the host with Apertis Update Manager (AUM)
AUM has been added into Apertis starting from 18.12. It allows to do
automatic and manual updates. Updates with USB mass storage devices are
-supported as well. CLI utility \`updatectl\` is aimed to manage the AUM
+supported as well. CLI utility `updatectl` is aimed to manage the AUM
daemon.
-AUM logs are available with command \`journalctl --unit
-apertis-update-manager\`
+AUM logs are available with command `journalctl --unit
+apertis-update-manager`
## OTA update
@@ -45,7 +45,7 @@ To enable OTA updates for one time:
gdbus call -y -d org.apertis.ApertisUpdateManager -o / -m org.freedesktop.DBus.Properties.Set org.apertis.ApertisUpdateManager UpdatesFromNetwork "<true>"
To enable OTA updates permanently please add into the configuration file
-\`/etc/apertis-update-manager.ini\` following:
+`/etc/apertis-update-manager.ini` following:
[Manager]
UpdateFromNetwork=true
@@ -58,7 +58,7 @@ available for download (check files with extention "\*.delta").
### Automatic offline update
It is enough to copy such file to the root of USB mass storage device
-with special name \`static-update.bundle\` and attach that device into
+with special name `static-update.bundle` and attach that device into
the target system. AUM will automatically detect the update file and try
to use it for the system upgrade.
@@ -76,7 +76,7 @@ situation for incorrect upgrade and revert the system to the previous
state. More details are available in [manual test of
rollback](https://qa.apertis.org/apertis-update-manager-rollback.html).
-# Updating the host with \`ostree\` tool
+# Updating the host with OSTree tool
## OTA updates
@@ -94,10 +94,10 @@ below and reboot.
# Locally available deployments
OSTree can show the deployments available. This can be though of as
-seeing the branches in a call to \`git branch\`. The star symbol
-(\`\*\`) is attached to the commit currently in use.
+seeing the branches in a call to `git branch`. The star symbol
+(`\*`) is attached to the commit currently in use.
-Immediately after a call to \`ostree admin update\`, the \`(pending)\`
+Immediately after a call to `ostree admin update`, the `(pending)`
label is attached to the commit to use on next boot.
$ sudo ostree admin status
@@ -106,7 +106,7 @@ label is attached to the commit to use on next boot.
* apertis 398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a.0
origin refspec: origin:apertis/18.06/amd64-uefi/minimal
-After the reboot, the \`(rollback)\` label is attached to the commit
+After the reboot, the `(rollback)` label is attached to the commit
that was in use before the update.
$ sudo ostree admin status
@@ -119,8 +119,8 @@ that was in use before the update.
After an update, OSTree kept a reference to the previous release that
was deployed. It is possible to switch to this release by using the
-commit id that was returned in a call to \`OSTree admin status\` (with
-the \`.0\` extension removed).
+commit id that was returned in a call to `ostree admin status` (with
+the `.0` extension removed).
$ sudo ostree admin upgrade --allow-downgrade --deploy-only
--override-commit=398824a16a766149a9c025311745472739f85d310fd6b1346456050dc112671a -r
--
GitLab