Browse Source

minor formatting / comment fixes

Roger Dingledine 14 years ago
parent
commit
1ac1f048ef
3 changed files with 14 additions and 13 deletions
  1. 5 5
      doc/HACKING
  2. 1 1
      doc/Makefile.am
  3. 8 7
      src/or/geoip.c

+ 5 - 5
doc/HACKING

@@ -50,14 +50,14 @@ When you do a commit that needs a ChangeLog entry, add a new file to
 the "changes" toplevel subdirectory.  It should have the format of a
 the "changes" toplevel subdirectory.  It should have the format of a
 one-entry changelog section from the current ChangeLog file, as in
 one-entry changelog section from the current ChangeLog file, as in
 
 
-   o Major bugfixes:
-      - Fix a potential buffer overflow.  Fixes bug 9999.  Bugfix on
-        Tor 0.3.1.4-beta.
+  o Major bugfixes:
+    - Fix a potential buffer overflow. Fixes bug 9999; bugfix on
+      0.3.1.4-beta.
 
 
 To write a changes file, first categorize the change.  Some common categories
 To write a changes file, first categorize the change.  Some common categories
 are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code
 are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code
-simplifications and refactoring.  Then say what the change does.  Then, if
-it's a bugfix, then mention what bug it fixes and when the bug was
+simplifications and refactoring.  Then say what the change does.  If
+it's a bugfix, mention what bug it fixes and when the bug was
 introduced.  To find out which Git tag the change was introduced in,
 introduced.  To find out which Git tag the change was introduced in,
 you can use "git describe --contains <sha1 of commit>".
 you can use "git describe --contains <sha1 of commit>".
 
 

+ 1 - 1
doc/Makefile.am

@@ -30,7 +30,7 @@ doc_DATA =
 endif
 endif
 
 
 EXTRA_DIST = HACKING asciidoc-helper.sh                      \
 EXTRA_DIST = HACKING asciidoc-helper.sh                      \
-             $(html_in) $(man_in) $(txt_in)		     \
+             $(html_in) $(man_in) $(txt_in)                  \
              tor-osx-dmg-creation.txt tor-rpm-creation.txt   \
              tor-osx-dmg-creation.txt tor-rpm-creation.txt   \
              tor-win32-mingw-creation.txt
              tor-win32-mingw-creation.txt
 
 

+ 8 - 7
src/or/geoip.c

@@ -3,9 +3,10 @@
 
 
 /**
 /**
  * \file geoip.c
  * \file geoip.c
- * \brief Functions related to maintaining an IP-to-country database and to
- *    summarizing client connections by country to entry guards, bridges, and
- *    directories as well as statistics on answering network status requests.
+ * \brief Functions related to maintaining an IP-to-country database;
+ * to summarizing client connections by country to entry guards, bridges,
+ * and directory servers; and for statistics on answering network status
+ * requests.
  */
  */
 
 
 #define GEOIP_PRIVATE
 #define GEOIP_PRIVATE
@@ -765,10 +766,10 @@ geoip_get_dirreq_history(geoip_client_action_t action,
 
 
 /** Return a newly allocated comma-separated string containing entries for
 /** Return a newly allocated comma-separated string containing entries for
  * all the countries from which we've seen enough clients connect as a
  * all the countries from which we've seen enough clients connect as a
- * bridge, directory, or entry guard. The entry format is cc=num where num
- * is the number of IPs we've seen connecting from that country, and cc is
- * a lowercased country code. Returns NULL if we don't want to export
- * geoip data yet. */
+ * bridge, directory server, or entry guard. The entry format is cc=num
+ * where num is the number of IPs we've seen connecting from that country,
+ * and cc is a lowercased country code. Returns NULL if we don't want
+ * to export geoip data yet. */
 char *
 char *
 geoip_get_client_history(geoip_client_action_t action)
 geoip_get_client_history(geoip_client_action_t action)
 {
 {