From: Antoine Pitrou <solipsis@pitrou.net>
Date: Fri, 22 Jun 2012 20:07:01 +0000 (+0200)
Subject: Add a docstring at the top of Tools/ssl/make_ssl_data.py
X-Git-Tag: v3.3.0b1~154^2~4^2~1
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=ffd4d47d0b88a4b2ef8b1d0e3972a0f5d75fc102;p=python

Add a docstring at the top of Tools/ssl/make_ssl_data.py
---

diff --git a/Tools/ssl/make_ssl_data.py b/Tools/ssl/make_ssl_data.py
index 87b3ec2c6b..10244d106f 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