From fe807046b4c4645463bf1730e23ac28b1f79d311 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Oudin?= Date: Tue, 30 Jan 2018 16:27:54 +0100 Subject: [PATCH 1/2] Better formatting of CPU usage documentation This is now displayed as a list, with bold fonts for each bullet. Refers https://github.com/borgbackup/borg/issues/3554 --- docs/usage_general.rst.inc | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/usage_general.rst.inc b/docs/usage_general.rst.inc index d59d2795b..2c48b6c26 100644 --- a/docs/usage_general.rst.inc +++ b/docs/usage_general.rst.inc @@ -306,12 +306,12 @@ all the resource usage occurs in that one process, so just add up client + server to get the approximate resource usage. CPU client: - borg create: does chunking, hashing, compression, crypto (high CPU usage) - chunks cache sync: quite heavy on CPU, doing lots of hashtable operations. - borg extract: crypto, decompression (medium to high CPU usage) - borg check: similar to extract, but depends on options given. - borg prune / borg delete archive: low to medium CPU usage - borg delete repo: done on the server + - **borg create:** does chunking, hashing, compression, crypto (high CPU usage) + - **chunks cache sync:** quite heavy on CPU, doing lots of hashtable operations. + - **borg extract:** crypto, decompression (medium to high CPU usage) + - **borg check:** similar to extract, but depends on options given. + - **borg prune / borg delete archive:** low to medium CPU usage + - **borg delete repo:** done on the server It won't go beyond 100% of 1 core as the code is currently single-threaded. Especially higher zlib and lzma compression levels use significant amounts of CPU cycles. Crypto might be cheap on the CPU (if hardware accelerated) or From 4e50dc6d94e965e76e21ca26169d33b9cb0a5d29 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Oudin?= Date: Tue, 30 Jan 2018 16:29:31 +0100 Subject: [PATCH 2/2] Link to offline documentation Add a link to the offline documentation in README.rst. Refers https://github.com/borgbackup/borg/issues/3502 --- README.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.rst b/README.rst index 92b377509..ff0c5b1b9 100644 --- a/README.rst +++ b/README.rst @@ -16,8 +16,10 @@ fully trusted targets. See the `installation manual`_ or, if you have already downloaded Borg, ``docs/installation.rst`` to get started with Borg. +There is also an `offline documentation`_ available, in mutiple formats. .. _installation manual: https://borgbackup.readthedocs.org/en/stable/installation.html +.. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads Main features ~~~~~~~~~~~~~ @@ -142,6 +144,7 @@ Links * `Releases `_, `PyPI packages `_ and `ChangeLog `_ +* `Offline Documentation `_ * `GitHub `_ and `Issue Tracker `_. * `Web-Chat (IRC) `_ and