Bladeren bron

Merge pull request #3589 from Gu1nness/docs

A few documentation fixes for Documentation issue 19
TW 7 jaren geleden
bovenliggende
commit
24b0bcb461
2 gewijzigde bestanden met toevoegingen van 9 en 6 verwijderingen
  1. 3 0
      README.rst
  2. 6 6
      docs/usage_general.rst.inc

+ 3 - 0
README.rst

@@ -16,8 +16,10 @@ fully trusted targets.
 
 
 See the `installation manual`_ or, if you have already
 See the `installation manual`_ or, if you have already
 downloaded Borg, ``docs/installation.rst`` to get started with Borg.
 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
 .. _installation manual: https://borgbackup.readthedocs.org/en/stable/installation.html
+.. _offline documentation: https://readthedocs.org/projects/borgbackup/downloads
 
 
 Main features
 Main features
 ~~~~~~~~~~~~~
 ~~~~~~~~~~~~~
@@ -141,6 +143,7 @@ Links
 * `Releases <https://github.com/borgbackup/borg/releases>`_,
 * `Releases <https://github.com/borgbackup/borg/releases>`_,
   `PyPI packages <https://pypi.python.org/pypi/borgbackup>`_ and
   `PyPI packages <https://pypi.python.org/pypi/borgbackup>`_ and
   `ChangeLog <https://github.com/borgbackup/borg/blob/master/docs/changes.rst>`_
   `ChangeLog <https://github.com/borgbackup/borg/blob/master/docs/changes.rst>`_
+* `Offline Documentation <https://readthedocs.org/projects/borgbackup/downloads>`_
 * `GitHub <https://github.com/borgbackup/borg>`_ and
 * `GitHub <https://github.com/borgbackup/borg>`_ and
   `Issue Tracker <https://github.com/borgbackup/borg/issues>`_.
   `Issue Tracker <https://github.com/borgbackup/borg/issues>`_.
 * `Web-Chat (IRC) <http://webchat.freenode.net/?randomnick=1&channels=%23borgbackup&uio=MTY9dHJ1ZSY5PXRydWUa8>`_ and
 * `Web-Chat (IRC) <http://webchat.freenode.net/?randomnick=1&channels=%23borgbackup&uio=MTY9dHJ1ZSY5PXRydWUa8>`_ and

+ 6 - 6
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.
 server to get the approximate resource usage.
 
 
 CPU client:
 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.
     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
     Especially higher zlib and lzma compression levels use significant amounts
     of CPU cycles. Crypto might be cheap on the CPU (if hardware accelerated) or
     of CPU cycles. Crypto might be cheap on the CPU (if hardware accelerated) or