Documentation clarified re. config socket listener protocol

2 files changed, 7 insertions, 4 deletions

diff --git a/Doc/lib/liblogging.tex b/Doc/lib/liblogging.tex
index 8146059..cca83ca 100644
--- a/Doc/lib/liblogging.tex
+++ b/Doc/lib/liblogging.tex
@@ -1396,7 +1396,10 @@ configurations. If no port is specified, the module's default
 will be sent as a file suitable for processing by \function{fileConfig()}.
 Returns a \class{Thread} instance on which you can call \method{start()}
 to start the server, and which you can \method{join()} when appropriate.
-To stop the server, call \function{stopListening()}.
+To stop the server, call \function{stopListening()}. To send a configuration
+to the socket, read in the configuration file and send it to the socket
+as a string of bytes preceded by a four-byte length packed in binary using
+struct.\code{pack(">L", n)}.
 \end{funcdesc}
 
 \begin{funcdesc}{stopListening}{}
diff --git a/Lib/logging/config.py b/Lib/logging/config.py
index ea157db..22132b1 100644
--- a/Lib/logging/config.py
+++ b/Lib/logging/config.py
@@ -225,9 +225,9 @@ def listen(port=DEFAULT_LOGGING_CONFIG_PORT):
             """
             Handle a request.
 
-            Each request is expected to be a 4-byte length,
-            followed by the config file. Uses fileConfig() to do the
-            grunt work.
+            Each request is expected to be a 4-byte length, packed using
+            struct.pack(">L", n), followed by the config file.
+            Uses fileConfig() to do the grunt work.
             """
             import tempfile
             try: