[tor-bugs] #25024 [Core Tor/Tor]: Add optional spell check to makefile to check for typos in tor source code.

[Tor Bug Tracker & Wiki]

#25024: Add optional spell check to makefile to check for typos in tor source code.
------------------------------------------+--------------------------------
 Reporter:  fristonio                     |          Owner:  alison
     Type:  enhancement                   |         Status:  needs_revision
 Priority:  Low                           |      Milestone:  Tor:
                                          |  0.3.4.x-final
Component:  Core Tor/Tor                  |        Version:
 Severity:  Minor                         |     Resolution:
 Keywords:  tor-comment, review-group-34  |  Actual Points:
Parent ID:                                |         Points:  0.5
 Reviewer:  asn                           |        Sponsor:
------------------------------------------+--------------------------------
Changes (by asn):

 * status:  needs_review => needs_revision


Comment:

 Please see branch `ticket25024` in my github repo
 (https://github.com/asn-d6/tor), which includes fristonio's patch, rebased
 to latest master, with some word changes to make it obvious that misspell
 is an optional feature.

 I rebased to master so that it includes #23650 patch. However I noticed
 that there are still a few typos in the codebase. I started fixing them
 but then I noticed that some of them are not actually typos but are either
 spanish words, or partial-words because of the way C strings are
 formatted. e.g.:
 {{{
   config_line_append(&labels, "Adios", "planetas");
 ./src/test/test_conscache.c:44:40: "planetas" is a misspelling of
 "planets"
   memcpy(ext_or_auth_cookie, "s beside you? When I count, ther", 32);
 ./src/test/test_extorport.c:246:58: "ther" is a misspelling of "there"
 }}}

 What should we do about these cases? We could use misspell's `-i` switch
 to ignore those corrections, but does this scale? We could disallow
 spanish words or partial words but that would be too authoritarian...

 I'm gonna mark this as `needs_revision` until we find a solution to the
 above, since IMO it doesn't make sense to have a spellchecker that will
 always complain about non-issues.

 Fristonio, what would you do here? :)

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