[minion-cvs] Many documentation/code cleanups, as suggested by Roger.

[nickm@seul.org (Nick Mathewson)]

Update of /home/minion/cvsroot/src/minion
In directory moria.seul.org:/tmp/cvs-serv25507

Modified Files:
	HACKING TODO 
Log Message:
Many documentation/code cleanups, as suggested by Roger.

Also...

Common.py:
	- Recover from missing /usr/bin/shred.
	- Call waitpid properly

MMTPServer.py:
	- Handle interrupted select.
	- Call setsockopt correctly. (socket.SOL_SOCKET != 0, no matter what
          the example code I was reading might have said.)
	- Simplify maxBytes argument out of expectRead method.

Packet.py:
	- Be a little stricter about reply block length.

PacketHandler.py:
	- A list of private keys requires a list of hash logs.

Queue.py:
	- Avoid having multiple instances of shred running at once; they
	  seem to step on one another's toes.
	- Add more bits to a handle.

__init__.py:
	- Make __init__.py act like a regular __init__ file.


test.py:
	- Be a bit more careful about shredding files and closing sockets.

_minionlib.h:
	- Refactor individual METHOD macros into a common declaration.

crypt.c:
	- Replace an impossible error with an assert
	
main.c:
	- More comments

tls.c:
	- Better description of SSL_ERROR_SYSCALL




Index: HACKING
===================================================================
RCS file: /home/minion/cvsroot/src/minion/HACKING,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- HACKING	25 Jun 2002 11:41:07 -0000	1.4
+++ HACKING	1 Jul 2002 18:03:04 -0000	1.5
@@ -2,7 +2,7 @@
 
 Requirements:
 	Python 2.0-2.2  (see PORTING NOTES below)
-	OpenSSL 0.9.7 (you'll need to download a snapshot. Also see PORTING)
+	OpenSSL 0.9.7 (you'll need to download a snapshot. Also see PORTING.)
 	Working /dev/urandom (see PORTING NOTES below)
 
 Setting up:
@@ -17,8 +17,7 @@
 	make time
 
 Things to hack:
-	See the TODO list.  It would be really nice if somebody could
-	hack up as much of MMTP as possible in C.
+	See the TODO list.
 
 DESIGN PRINCIPALS:
     - It's not done till it's documented.
@@ -49,14 +48,15 @@
        ------------------
 
 CODING STYLE:
-    - See PEP-0008.  I believe in most of it.
+    - See PEP-0008: "Style Guide For Python Code".  I believe in most of it.
+      (http://www.python.org/peps/pep-0008.html)
     - Also see PEP-0257 for documentation; we're not there yet, but it's
-      happening.
+      happening. (http://www.python.org/peps/pep-0257.html)
     - The magic string "XXXX" indicates a defect in the code. "FFFF" indicates
       a missing feature, and "????" indicates an untested or iffy block.
 
 PORTABILITY NOTES:
-    - I've already backported to 2.0.  (I refuse to backport to 1.5 or
+    - I've already backported to Python 2.0.  (I refuse to backport to 1.5 or
       1.6.)
     - Right now, we're dependant on OpenSSL. OpenSSL's license has an
       old-style BSD license that isn't compatible with the GPL.  We

Index: TODO
===================================================================
RCS file: /home/minion/cvsroot/src/minion/TODO,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -d -r1.5 -r1.6
--- TODO	25 Jun 2002 11:41:07 -0000	1.5
+++ TODO	1 Jul 2002 18:03:04 -0000	1.6
@@ -1,3 +1,7 @@
+Legend:
+	- Not done
+	. Partially done
+	o Done
 
 NEEDS TO BE WRITTEN
 
@@ -19,7 +23,7 @@
 			- Bad recipients
 			- Hanging connections
 			- Hunt down leaks
-	- More standard __init__.py
+	o More standard __init__.py
 	- CLI
 	- Server description blocks
 	- Main loop for server