summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAntoine Pitrou <solipsis@pitrou.net>2012-06-22 20:07:01 (GMT)
committerAntoine Pitrou <solipsis@pitrou.net>2012-06-22 20:07:01 (GMT)
commitffd4d47d0b88a4b2ef8b1d0e3972a0f5d75fc102 (patch)
tree2e1b02e4df9a1168a31416a077dee4d1947cace9
parent5f6213be2d5890d7bc3ba62db58ac1ce0215aaaa (diff)
downloadcpython-ffd4d47d0b88a4b2ef8b1d0e3972a0f5d75fc102.zip
cpython-ffd4d47d0b88a4b2ef8b1d0e3972a0f5d75fc102.tar.gz
cpython-ffd4d47d0b88a4b2ef8b1d0e3972a0f5d75fc102.tar.bz2
Add a docstring at the top of Tools/ssl/make_ssl_data.py
-rw-r--r--Tools/ssl/make_ssl_data.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/Tools/ssl/make_ssl_data.py b/Tools/ssl/make_ssl_data.py
index 87b3ec2..10244d1 100644
--- a/Tools/ssl/make_ssl_data.py
+++ b/Tools/ssl/make_ssl_data.py
@@ -1,5 +1,16 @@
#! /usr/bin/env python3
+"""
+This script should be called *manually* when we want to upgrade SSLError
+`library` and `reason` mnemnonics to a more recent OpenSSL version.
+
+It takes two arguments:
+- the path to the OpenSSL include files' directory
+ (e.g. openssl-1.0.1-beta3/include/openssl/)
+- the path to the C file to be generated
+ (probably Modules/_ssl_data.h)
+"""
+
import datetime
import os
import re