[tor-bugs] #4893 [Tor Client]: Rename inconsistent function and type names

Tor Bug Tracker & Wiki torproject-admin at torproject.org
Wed Jan 11 20:21:33 UTC 2012


#4893: Rename inconsistent function and type names
------------------------+---------------------------------------------------
 Reporter:  nickm       |          Owner:                    
     Type:  defect      |         Status:  new               
 Priority:  normal      |      Milestone:  Tor: 0.2.3.x-final
Component:  Tor Client  |        Version:                    
 Keywords:              |         Parent:                    
   Points:              |   Actualpoints:                    
------------------------+---------------------------------------------------
 By convention:

   * Types do not have "`env`" or "object`" or whatever in them.
   * The primary function to free a foo is called `foo_free()`, not
 `foo_free_env()`.
   * The primary function that allocates and returns a newly allocated foo
 is called `foo_new()`, not `foo_create()` or `foo_new_env()`.

 We violate these rules, though, with a fair number of longstanding types
 and identifiers.  How annoying!  Let's fix that.

 This will make some pending unmerged code get merge conflicts or need
 rewrites, but now that we're moving towards the end of the 0.2.3.x release
 cycle, it's the perfect time to do that.

-- 
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/4893>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online


More information about the tor-bugs mailing list