mirror/borg
1
0
Fork 0
mirror of https://github.com/borgbackup/borg.git synced 2025-01-31 19:52:22 +00:00
Code Issues Releases Wiki Activity

add more specific warning about write-access debug commands

Browse source
This commit is contained in:
Thomas Waldmann 2016-09-30 21:09:02 +02:00
parent 3a3cdadeba
commit a65707beb8
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
docs/usage.rst
View file

@ -567,9 +567,20 @@ Miscellaneous Help
Debug Commands
--------------
There are some more commands (all starting with "debug-") which are all
**not intended for normal use** and **potentially very dangerous** if used incorrectly.
For example, ``borg debug-put-obj`` and ``borg debug-delete-obj`` will only do
what their name suggests: put objects into repo / delete objects from repo.
Please note:
- they will not update the chunks cache (chunks index) about the object
- they will not update the manifest (so no automatic chunks index resync is triggered)
- they will not check whether the object is in use (e.g. before delete-obj)
- they will not update any metadata which may point to the object
They exist to improve debugging capabilities without direct system access, e.g.
in case you ever run into some severe malfunction. Use them only if you know
what you are doing or if a trusted |project_name| developer tells you what to do.