浏览代码

Merge pull request #1666 from ThomasWaldmann/improve-borg-debug-docs

add more specific warning about write-access debug commands
TW 8 年之前
父节点
当前提交
d8a7b17924
共有 1 个文件被更改,包括 11 次插入0 次删除
  1. 11 0
      docs/usage.rst

+ 11 - 0
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.