[or-cvs] touch up the TODO and HACKING files
arma at seul.org
arma at seul.org
Tue Jul 4 03:33:19 UTC 2006
Update of /home/or/cvsroot/tor/doc
In directory moria:/tmp/cvs-serv6849
Modified Files:
TODO HACKING
Log Message:
touch up the TODO and HACKING files
Index: TODO
===================================================================
RCS file: /home/or/cvsroot/tor/doc/TODO,v
retrieving revision 1.460
retrieving revision 1.461
diff -u -p -d -r1.460 -r1.461
--- TODO 30 Jun 2006 10:50:43 -0000 1.460
+++ TODO 4 Jul 2006 03:33:16 -0000 1.461
@@ -14,8 +14,8 @@ P - phobos claims
. <nickm> "Let's try to find a way to make it run and make the version
match, but if not, let's just make it run."
- - <arma> should we detect if we have a --with-ssl-dir and try the -R
- by default, if it works?
+ - <arma> "should we detect if we have a --with-ssl-dir and try the -R
+ by default, if it works?"
Items for 0.1.2.x:
- Servers are easy to setup and run: being a relay is about as easy as
@@ -61,6 +61,8 @@ N . Improve memory usage on tight-memo
- "bandwidth classes", for incoming vs initiated-here conns.
o Asynchronous DNS
+ - and test it
+ - make it the default on platforms where it works
- Security improvements
- Directory guards
@@ -163,6 +165,8 @@ Minor items for 0.1.2.x as time permits.
- If the server is spewing complaints about raising your ulimit -n,
we should add a note about this to the server descriptor so other
people can notice too.
+ - rate limit the number of exit connections to a given destination, to
+ help with DoS/crawling issues.
- cpu fixes:
- see if we should make use of truncate to retry
- kill dns workers more slowly
@@ -178,18 +182,6 @@ Minor items for 0.1.2.x as time permits.
- Win32 installer plus privoxy, sockscap/freecap, etc.
- Vet win32 systray helper code
- . Update the hidden service stuff for the new dir approach.
- - switch to an ascii format, maybe sexpr?
- - authdirservers publish blobs of them.
- - other authdirservers fetch these blobs.
- - hidserv people have the option of not uploading their blobs.
- - you can insert a blob via the controller.
- - and there's some amount of backwards compatibility.
- - teach clients, intro points, and hidservs about auth mechanisms.
- - come up with a few more auth mechanisms.
- - auth mechanisms to let hidden service midpoint and responder filter
- connection requests.
-
- Improve controller
- change circuit status events to give more details, like purpose,
whether they're internal, when they become dirty, when they become
@@ -217,6 +209,17 @@ Minor items for 0.1.2.x as time permits.
- Make everything work with hidden services
Future version:
+ . Update the hidden service stuff for the new dir approach.
+ - switch to an ascii format, maybe sexpr?
+ - authdirservers publish blobs of them.
+ - other authdirservers fetch these blobs.
+ - hidserv people have the option of not uploading their blobs.
+ - you can insert a blob via the controller.
+ - and there's some amount of backwards compatibility.
+ - teach clients, intro points, and hidservs about auth mechanisms.
+ - come up with a few more auth mechanisms.
+ - auth mechanisms to let hidden service midpoint and responder filter
+ connection requests.
- Bind to random port when making outgoing connections to Tor servers,
to reduce remote sniping attacks.
- Have new people be in limbo and need to demonstrate usefulness
@@ -246,7 +249,8 @@ Future version:
that it is able to rotate through. (maybe)
- let each hidden service (or other thing) specify its own
OutboundBindAddress?
- - Better hidden service performance, with possible redesign.
+ - Have a mode that doesn't write to disk much, so we can run Tor on
+ flash memory (e.g. Linksys routers).
Blue-sky:
- Patch privoxy and socks protocol to pass strings to the browser.
Index: HACKING
===================================================================
RCS file: /home/or/cvsroot/tor/doc/HACKING,v
retrieving revision 1.16
retrieving revision 1.17
diff -u -p -d -r1.16 -r1.17
--- HACKING 16 Jun 2005 20:32:40 -0000 1.16
+++ HACKING 4 Jul 2006 03:33:17 -0000 1.17
@@ -6,12 +6,14 @@
Use tor_malloc, tor_free, tor_snprintf, tor_strdup, and tor_gettimeofday
instead of their generic equivalents. (They always succeed or exit.)
- Use INLINE instead of 'inline', so that we work properly on windows.
+ You can get a full list of the compatibility functions that Tor provides
+ by looking through src/common/util.h and src/common/compat.h.
+
+ Use 'INLINE' instead of 'inline', so that we work properly on Windows.
1.2. Calling and naming conventions
- Whenever possible, functions should return -1 on error and and 0 on
- success.
+ Whenever possible, functions should return -1 on error and 0 on success.
For multi-word identifiers, use lowercase words combined with
underscores. (e.g., "multi_word_identifier"). Use ALL_CAPS for macros and
@@ -52,7 +54,7 @@
you need to (or can) do about it.
DEBUG is for everything louder than INFO.
- [XXX Proposed convention: every messages of severity INFO or higher should
+ [XXX Proposed convention: every message of severity INFO or higher should
either (A) be intelligible to end-users who don't know the Tor source; or
(B) somehow inform the end-users that they aren't expected to understand
the message (perhaps with a string like "internal error"). Option (A) is
@@ -60,8 +62,8 @@
1.5. Doxygen
- We use the 'doxygen' utility to generate documentation from our source code.
- Here's how to use it:
+ We use the 'doxygen' utility to generate documentation from our
+ source code. Here's how to use it:
1. Begin every file that should be documented with
/**
@@ -98,16 +100,17 @@
struct foo {
/** You can put the comment before an element; */
int a;
- int b; /**< Or use the less-than symbol to put the comment after the element. */
+ int b; /**< Or use the less-than symbol to put the comment
+ * after the element. */
};
5. To generate documentation from the Tor source code, type:
$ doxygen -g
- To generate a file called 'Doxyfile'. Edit that file and run 'doxygen' to
- generate the API documentation.
+ To generate a file called 'Doxyfile'. Edit that file and run
+ 'doxygen' to generate the API documentation.
- 6. See the Doxygen manual for more information; this summary just scratches
- the surface.
+ 6. See the Doxygen manual for more information; this summary just
+ scratches the surface.
More information about the tor-commits
mailing list