[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[minion-cvs] HACKING: add note on magic comments



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

Modified Files:
	HACKING TODO pycheckrc 
Log Message:
HACKING: add note on magic comments

Packet/PacketHandler/BuildMessage/test: 
	Implement Reply Block format recently added to spec.

Common:
	Improve documentation on secure deleting

MMTPServer/client:
	Add stubs for keyid checking.  Now blocking on spec for how to
	hash a public key.

tls.c:
	Fix mm_TLSSock_check -> mm_TLSSock_Check.

Everywhere else:
	- Fix code style according to PEP-0008 guidelines
	- Improve doc style to be closer to PEP-0257 guidelines
	- General cleanups and removal of dead code.


Index: HACKING
===================================================================
RCS file: /home/minion/cvsroot/src/minion/HACKING,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -d -r1.3 -r1.4
--- HACKING	24 Jun 2002 20:28:18 -0000	1.3
+++ HACKING	25 Jun 2002 11:41:07 -0000	1.4
@@ -50,6 +50,10 @@
 
 CODING STYLE:
     - See PEP-0008.  I believe in most of it.
+    - Also see PEP-0257 for documentation; we're not there yet, but it's
+      happening.
+    - 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

Index: TODO
===================================================================
RCS file: /home/minion/cvsroot/src/minion/TODO,v
retrieving revision 1.4
retrieving revision 1.5
diff -u -d -r1.4 -r1.5
--- TODO	24 Jun 2002 20:28:18 -0000	1.4
+++ TODO	25 Jun 2002 11:41:07 -0000	1.5
@@ -1,23 +1,16 @@
 
 NEEDS TO BE WRITTEN
 
-NEXT CHECKIN:
-	- Code cleanup
-		- PEP 8
-		- PEP 257
-
 FOR 0.1: (The rough edges release)
-	- Make crypt.c read/write stuff in PEM.
+	- Make crypt.c read/write stuff in PEM?
 	- Local delivery module
 	- Manager process
 	- Configuration code
 	- Logging/debugging/warning code
-	- Reading messages sent to reply blocks
-	- Coding style guide
+	o Coding style guide
 	- MMTP		
 		- Generate X509/RSA/DH files as needed
-		- Hunt down leaks
-		- Check Key IDs
+		. Check Key IDs
 		- Renegotiate connections
 		- Timeouts
 		- Tests for all cases:
@@ -25,13 +18,16 @@
 			- Bad senders
 			- Bad recipients
 			- Hanging connections
-	- More standard __init__
+			- Hunt down leaks
+	- More standard __init__.py
 	- CLI
 	- Server description blocks
 	- Main loop for server
 	- Clean shutdown for server
-	- Reply block storage and format.
+	o Reply block format
+	- External reply block format
 	- End-to-end payload encryption, if we ever agree on a spec.
+		- Reading messages sent to reply blocks
 	- Versioning :)
 
 FOR 0.2: (The first hacker release)

Index: pycheckrc
===================================================================
RCS file: /home/minion/cvsroot/src/minion/pycheckrc,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -d -r1.1 -r1.2
--- pycheckrc	24 Jun 2002 20:28:18 -0000	1.1
+++ pycheckrc	25 Jun 2002 11:41:07 -0000	1.2
@@ -103,9 +103,8 @@
 maxBranches = 20
 maxReturns = 10
 maxArgs = 7
-maxLocals = 10
+maxLocals = 15
 maxReferences = 10
-
 
 # bool:  ignore all warnings from standard library components
 #	 (this includes anything under the standard library, eg, site-packages)