mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2024-12-26 17:57:59 +00:00
Code Issues Releases Wiki Activity

Merge pull request #3589 from Gu1nness/docs

Browse source 
A few documentation fixes for Documentation issue 19
This commit is contained in:
TW 2018-02-10 11:31:19 +01:00 committed by GitHub
commit 24b0bcb461
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.rst
View file

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

12
docs/usage_general.rst.inc
View file

@ -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) - **borg create:** does chunking, hashing, compression, crypto (high CPU usage)
chunks cache sync: quite heavy on CPU, doing lots of hashtable operations. - **chunks cache sync:** quite heavy on CPU, doing lots of hashtable operations.
borg extract: crypto, decompression (medium to high CPU usage) - **borg extract:** crypto, decompression (medium to high CPU usage)
borg check: similar to extract, but depends on options given. - **borg check:** similar to extract, but depends on options given.
borg prune / borg delete archive: low to medium CPU usage - **borg prune / borg delete archive:** low to medium CPU usage
borg delete repo: done on the server - **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