Tor's control protocol misspells "Dependent"

In getinfo_helper_config(), tor misspells "Dependent" as "Dependant".

There's probably nothing we can do about this, because it's part of the controller interface.

But we should at least document it, preferably in the code and the control spec.

changed milestone to %Tor: 0.3.0.x-final

added component::core tor/tor doc milestone::Tor: 0.3.0.x-final owner::jryans priority::medium resolution::fixed severity::trivial status::closed tor-controller type::defect version::tor unspecified labels

Trac:
Milestone: Tor: very long term to Tor: 0.2.8.x-final

It is impossible that we will fix all 277 currently open 028 tickets before 028 releases. Time to move some out. This is my first pass through the "new" and "reopened" tickets, looking for things to move to ???.

Trac:
Milestone: Tor: 0.2.8.x-final to Tor: 0.2.???

Milestone renamed

Trac:
Milestone: Tor: 0.2.??? to Tor: 0.3.???

Trac:
Username: jryans
Status: new to assigned
Cc: N/A to jryans@gmail.com
Owner: N/A to jryans
Reviewer: N/A to N/A

Add a comment in config code and note in control spec.

tor: https://github.com/torproject/tor/compare/master...jryans:dependant-misspelling torspec: https://github.com/torproject/torspec/compare/master...jryans:dependant-misspelling

Trac:
Username: jryans
Status: assigned to needs_review

Trac:
Milestone: Tor: 0.3.??? to Tor: 0.3.0.x-final

Is there some way to fix it, and tolerate both for now or something, so in the distant future we can get rid of the typo?

Damian, does arm or stem use the "getinfo config/names" feature? Maybe we can just fix it and break backward compatibility? :)

Trac:
Cc: jryans@gmail.com to jryans@gmail.com, atagar

Since it's an output of the control protocol, we have to choose one or the other.

I suggest we fix the bug in 0.3.0, and note that it's a breaking change, and then say in the control spec that controllers should accept both, noting the version that the fix was made in (0.3.0.1-alpha, if we're lucky).

Trac:
Status: needs_review to needs_revision

Damian, does arm or stem use the "getinfo config/names" feature? Maybe we can just fix it and break backward compatibility? :)

Yes, both Stem and Nyx use 'GETINFO config/names'. Its used for tor-prompt's auto-completion for instance...

https://gitweb.torproject.org/stem.git/tree/stem/interpreter/autocomplete.py#n40

It's not the end of the world to leave a misspelled string in an interface. HTTP has "Referer", after all.

It seems nice to try fixing the misspelling if it's possible to do so. Maybe the community of Tor control protocol clients is small enough that it's within reason to try...?

Doing a quick skim of Stem and Nyx, it looks like:

• Stem only uses the config name from getinfo config/names, not the type, so it would be unaffected by the proposed change here
• Nyx does use the config type for a few cases, but seems to ignore this specific type (currently misspelled as Dependant)

atagar, is this analysis correct?

Trac:
Username: jryans
Status: needs_revision to needs_information

Hi jryans, sorry about the delay. Was down for a week with a cold. Yup, looks right to me. I'm not spotting anywhere in Stem or Nyx where renaming this would impact us.

Thanks for the confirmation atagar!

Here's a different branch where I've make a breaking change to fix the spelling as teor suggested in [comment:9 comment 9], since it appears to be safe for the most common control protocol clients.

tor: https://github.com/torproject/tor/compare/master...jryans:dependant-corrected torspec: https://github.com/torproject/torspec/compare/master...jryans:dependant-corrected

Trac:
Username: jryans
Status: needs_information to needs_review

Ok, one fix needed:

Replace "Tor XXX" with "Tor 0.3.0.2-alpha", as our best guess at the version this will be merged into.

Trac:
Status: needs_review to needs_revision
Version: N/A to Tor: unspecified

Okay, updated with the expected fix version. (I assume another round of review is not needed for this change.)

Trac:
Username: jryans
Status: needs_revision to merge_ready

merged!

Trac:
Resolution: N/A to fixed
Status: merge_ready to closed