diff Tools/ssl/make_ssl_data.py @ 77584:ad9f6e294d09

Add a docstring at the top of Tools/ssl/make_ssl_data.py
author Antoine Pitrou <solipsis@pitrou.net>
date Fri, 22 Jun 2012 22:07:01 +0200
parents e193fe3d017e
children
line wrap: on
line diff
--- a/Tools/ssl/make_ssl_data.py	Fri Jun 22 21:13:34 2012 +0200
+++ b/Tools/ssl/make_ssl_data.py	Fri Jun 22 22:07:01 2012 +0200
@@ -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