From 038ab0490884220d98a53720176c845f5a98a2c9 Mon Sep 17 00:00:00 2001 From: David Wilson Date: Mon, 16 Oct 2017 17:56:23 +0530 Subject: [PATCH] docs: convert paragraph to footnote. --- docs/howitworks.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/docs/howitworks.rst b/docs/howitworks.rst index 6d4cd43f..6dd8754b 100644 --- a/docs/howitworks.rst +++ b/docs/howitworks.rst @@ -26,7 +26,7 @@ implement the decompression. Python Command Line ################### -The Python command line sent to the host is a :mod:`zlib`-compressed and +The Python command line sent to the host is a :mod:`zlib`-compressed [#f1]_ and base64-encoded copy of the :py:meth:`mitogen.master.Stream._first_stage` function, which has been carefully optimized to reduce its size. Prior to compression and encoding, ``CONTEXT_NAME`` is replaced with the desired context @@ -41,12 +41,6 @@ component, decompress it and execute it as Python code. Base64 is used since to protect against any special characters that may be interpreted by the system shell in use. -Compression may seem redundant, however it is basically free and reducing IO is -always a good idea. The 33% / 200 byte saving may mean the presence or absence -of an additional frame on the network, or in real world terms after accounting -for SSH overhead, up to 2.3% reduced chance of a stall during connection setup -due to a dropped frame. - Forking The First Stage ####################### @@ -701,3 +695,12 @@ every case, for example when Python blocks signals during a variety of At some point it is likely Mitogen will be extended to support children running on Windows. When that happens, it would be nice if the process model on Windows and UNIX did not differ, and in fact the code used on both were identical. + + +.. rubric:: Footnotes + +.. [#f1] Compression may seem redundant, however it is basically free and reducing IO + is always a good idea. The 33% / 200 byte saving may mean the presence or + absence of an additional frame on the network, or in real world terms after + accounting for SSH overhead, around a 2% reduced chance of a stall during + connection setup due to a dropped frame.