浏览代码

docs: add section about debug commands

Thomas Waldmann 9 年之前
父节点
当前提交
b1eb784bd1
共有 1 个文件被更改,包括 10 次插入0 次删除
  1. 10 0
      docs/usage.rst

+ 10 - 0
docs/usage.rst

@@ -402,6 +402,16 @@ Miscellaneous Help
 .. include:: usage/help.rst.inc
 .. include:: usage/help.rst.inc
 
 
 
 
+Debug Commands
+--------------
+There are some more commands (all starting with "debug-") wich are are all
+**not intended for normal use** and **potentially very dangerous** if used incorrectly.
+
+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.
+
+
 Additional Notes
 Additional Notes
 ----------------
 ----------------