[Python-checkins] cpython: Add a docstring at the top of Tools/ssl/make_ssl_data.py

[antoine.pitrou]

http://hg.python.org/cpython/rev/ad9f6e294d09
changeset:   77584:ad9f6e294d09
parent:      77580:34319fc28da6
user:        Antoine Pitrou <solipsis at pitrou.net>
date:        Fri Jun 22 22:07:01 2012 +0200
summary:
  Add a docstring at the top of Tools/ssl/make_ssl_data.py

files:
  Tools/ssl/make_ssl_data.py |  11 +++++++++++
  1 files changed, 11 insertions(+), 0 deletions(-)


diff --git a/Tools/ssl/make_ssl_data.py b/Tools/ssl/make_ssl_data.py
--- 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

-- 
Repository URL: http://hg.python.org/cpython