From a11003862be3074b197dc4d40f2662bc126def8e Mon Sep 17 00:00:00 2001 From: David Wilson Date: Sat, 9 Sep 2017 00:21:05 +0530 Subject: [PATCH] Add warning to docs. --- docs/howitworks.rst | 6 +++--- docs/index.rst | 22 ++++++++++++++++++++++ 2 files changed, 25 insertions(+), 3 deletions(-) diff --git a/docs/howitworks.rst b/docs/howitworks.rst index 2fd663b3..286cd3a8 100644 --- a/docs/howitworks.rst +++ b/docs/howitworks.rst @@ -426,9 +426,9 @@ Example .. image:: images/context-tree.png In the diagram, when ``master`` is creating the ``sudo:node12b:webapp`` -context, it must send ``ADD_ROUTE`` messages to ``rack12``, ``dc1``, and -``bastion``; `node12b` does not require an ``ADD_ROUTE`` message since it has a -stream directly connected to the new context. +context, it must send ``ADD_ROUTE`` messages to ``rack12``, ``dc1``, +``bastion``, and itself; ``node12b`` does not require an ``ADD_ROUTE`` message +since it has a stream directly connected to the new context. When ``sudo:node22a:webapp`` wants to send a message to ``sudo:node12b:webapp``, the message will be routed as follows: diff --git a/docs/index.rst b/docs/index.rst index 80314b6a..e5c0870a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,6 +33,28 @@ common privilege escalation techniques like `sudo`, potentially in combination with exotic connection methods such as WMI, `telnet`, or console-over-IPMI. +.. raw:: html + + + +.. warning:: + + econtext is alpha-quality software. If intend to you use it, you should be + aware how little real world testing it has received, the total absence of + any tests, and the nightmare-level difficulty of debugging hangs in a tree + of processes running identical code straddling multiple thread and machine + boundaries! ``router.enable_debug()`` is your friend. + + If you think you have a use for this software, please `drop me an e-mail`_ + so that expectations and bugfixes can be managed sensibly. + + .. _drop me an e-mail: dw@botanicus.net + + Automatic Bootstrap ###################