From a65707beb8e98b4867ae951d40fd41b24aebdcf4 Mon Sep 17 00:00:00 2001 From: Thomas Waldmann Date: Fri, 30 Sep 2016 21:09:02 +0200 Subject: [PATCH] add more specific warning about write-access debug commands --- docs/usage.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/usage.rst b/docs/usage.rst index a3015f61b..0452c164a 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -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.