From bb71a8ee3b49aa2ad5aaa85c21ffe3d44e078ad6 Mon Sep 17 00:00:00 2001
From: Zooko O'Whielacronx <zooko@zooko.com>
Date: Fri, 15 Aug 2008 10:22:34 -0700
Subject: [PATCH] setup: doc string describing what the require_auto_deps()
 function is for

---
 _auto_deps.py | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/_auto_deps.py b/_auto_deps.py
index ee3a3eb5..0712ec02 100644
--- a/_auto_deps.py
+++ b/_auto_deps.py
@@ -20,6 +20,13 @@ if hasattr(sys, 'frozen'):
     install_requires=[]
 
 def require_auto_deps():
+    """
+    The purpose of this function is to raise a pkg_resources exception if any of the
+    requirements can't be imported.  This is just to give earlier and more explicit error
+    messages, as opposed to waiting until the source code tries to import some module from one
+    of these packages and gets an ImportError.  This function gets called from
+    src/allmydata/__init__.py .
+    """
     import pkg_resources
     for requirement in install_requires:
         try:
-- 
2.45.2