[tbb-bugs] #32534 [Applications/Tor Browser]: settle on one canonical jtorctl

Tor Bug Tracker & Wiki blackhole at torproject.org
Wed Nov 20 11:26:14 UTC 2019


#32534: settle on one canonical jtorctl
-------------------------------------------------+-------------------------
 Reporter:  eighthave                            |          Owner:  tbb-
                                                 |  team
     Type:  defect                               |         Status:  new
 Priority:  Medium                               |      Milestone:
Component:  Applications/Tor Browser             |        Version:
 Severity:  Normal                               |     Resolution:
 Keywords:  Android, tbb-mobile, jtorctl,        |  Actual Points:
  TorBrowserTeam202001                           |
Parent ID:                                       |         Points:
 Reviewer:                                       |        Sponsor:
-------------------------------------------------+-------------------------

Comment (by eighthave):

 I guess we should also have an automatic naming convention for translating
 ControlPort command names to Java method names.  The existing standard is
 to use camelCase for ControlPort commands with an `_` in them, and when
 there are clear words.  Then camelCase for methods that are not just
 direct calls for ControlPort commands.  For example:

 * `takeOwnership()` -> `TAKEOWNERSHIP`
 * `setEvents()` -> `SETEVENTS`
 * `addOnion()` -> `ADD_ONION`
 * `dropGuards()` -> `DROPGUARDS`
 * `resetConf()` -> `RESETCONF`
 * `hsFetch()` -> `HSFETCH`
 * `hsForget()` -> `HSFORGET`
 * `sendAndWaitForResponse()`

 So @sisbell's proposal looks good to me, except `takeownership()` should
 be `takeOwnership()`.

 I can put together this update for the things that I'm proposing, as long
 as Tor Project is willing to use it and make the releases to Maven
 Central.

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


More information about the tbb-bugs mailing list