Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  closed
 Priority:  Medium |  Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:  wontfix
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer:  asn|Sponsor:
---+
Changes (by nickm):

 * status:  needs_information => closed
 * resolution:   => wontfix


Comment:

 Okay, I think you're right here.  I don't know how to use this, but I'll
 remember how to find it in case we someday decide to resurrect the effort.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  needs_information
 Priority:  Medium |  Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer:  asn|Sponsor:
---+
Changes (by asn):

 * status:  needs_review => needs_information


Comment:

 I'm inclined to NACK this branch. I think such a big list of abbreviations
 will be hard to maintain and use both for us and for volunteers. Also I
 feel like the benefit does not outweight the overhead of enforcing the
 abbreviations and checking whether an abbreviation exists everytime you
 want to write code.

 Perhaps as a way to do short-term progress here would be to identify a
 bunch of important abbreviations that we get wrong often and fix those.

 And then if in the future this abbreviation inconsistency issue becomes a
 problem, we can revisit the list from comment:13 and see how to make it
 useful.

 Or we can ignore this ticket for now (which honestly would be my
 approach).

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  needs_review
 Priority:  Medium |  Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer:  asn|Sponsor:
---+
Changes (by asn):

 * reviewer:   => asn


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  needs_review
 Priority:  Medium |  Milestone:  Tor: 0.4.4.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer: |Sponsor:
---+
Changes (by nickm):

 * status:  needs_revision => needs_review
 * reviewer:  teor =>
 * milestone:  Tor: 0.4.2.x-final => Tor: 0.4.4.x-final


Comment:

 I'll need some feedback from the current reviewers: I'm wondering whether
 we think this is still a useful thing to do, and what we should do with
 it, if anything.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  needs_revision
 Priority:  Medium |  Milestone:  Tor: 0.4.2.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer:  teor   |Sponsor:  Sponsor31-can
---+

Comment (by teor):

 I think the scope of this ticket might be too big.

 Let's try to tackle it in a few different parts:

 * Use the same abbreviations for
   * module names (we might already do this)
   * source file names (we might already do this, but I bet there are a few
 exceptions)
   * functions used outside their module
   * functions in header files
   * other functions

 I don't know if we can enforce or automate these changes.

 I don't know how important this ticket is. Maybe we could decide to do
 other things for this sponsor.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
---+
 Reporter:  nickm  |  Owner:  nickm
 Type:  task   | Status:  needs_revision
 Priority:  Medium |  Milestone:  Tor: 0.4.2.x-final
Component:  Core Tor/Tor   |Version:
 Severity:  Normal | Resolution:
 Keywords:  doc, s31-docs 042-can  |  Actual Points:  0.9
Parent ID: | Points:  1
 Reviewer:  teor   |Sponsor:  Sponsor31-can
---+
Changes (by nickm):

 * keywords:  doc, s31-docs => doc, s31-docs 042-can


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_revision
 Priority:  Medium|  Milestone:  Tor: 0.4.2.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:  doc   |  Actual Points:  0.9
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+

Comment (by nickm):

 I think my answer for all three questions is "I don't know".  I can try to
 do so wrt the topic areas suggectino, but I don't have much of an idea how
 to migrate or enforce them.  Any suggestions?  Should we bring it up with
 the team?

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_revision
 Priority:  Medium|  Milestone:  Tor: 0.4.2.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:  doc   |  Actual Points:  0.9
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+
Changes (by teor):

 * status:  needs_review => needs_revision
 * reviewer:  catalyst => teor


Comment:

 I spoke with catalyst about these new abbreviations.

 * Do we have an (automated?) migration plan to the new abbreviations?
 * Can we split the patch into topic areas (or modules)?
 * How do we enforce the new abbreviations after migration?

 Answering these questions should help us move forward, and it will help me
 review the final list,

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  0.9
Parent ID:| Points:  1
 Reviewer:  catalyst  |Sponsor:  Sponsor31-must
--+
Changes (by asn):

 * reviewer:   => catalyst


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  0.9
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+

Comment (by teor):

 Oops, the PR is https://github.com/torproject/tor/pull/963

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  0.9
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by teor):

 * reviewer:  teor =>
 * actualpoints:  .7 => 0.9


Comment:

 I have reviewed the other half of the list.

 I made some general comments on the pull request, and some specific
 comments against particular abbreviations.

 I am not sure how we plan to converge on these abbreviations. Knowing the
 use cases will help future reviewers give more helpful advice.

 I am removing myself as a reviewer, because I will be on leave from the
 middle of this week.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+

Comment (by teor):

 I have reviewed about half of this list, I'll submit my review now. I'll
 finish the rest tomorrow.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+

Comment (by nickm):

 Replying to [comment:9 teor]:
 > I want to make comments on this file, and I'd usually do that through a
 pull request.
 > Where is it going to live?

 I don't know yet; I was undecided between doc/HACKING, the wiki, or
 something else.

 > I think I'll start by dumping it in doc/HACKING, and we can move it to
 its final location later,

 That's fine.

 > I also have a broader question:
 >
 > Are identifiers in the tor specifications in scope?
 > Juga and I spent a lot of time trying to name fields for the bandwidth
 file.
 > A set of standard abbreviations would have been very useful.

 This list does not try to cover the specification, but having a consistent
 set of abbreviations and symbols to use there would be good.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+

Comment (by teor):

 I want to make comments on this file, and I'd usually do that through a
 pull request.
 Where is it going to live?
 I think I'll start by dumping it in doc/HACKING, and we can move it to its
 final location later,

 I also have a broader question:

 Are identifiers in the tor specifications in scope?
 Juga and I spent a lot of time trying to name fields for the bandwidth
 file.
 A set of standard abbreviations would have been very useful.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:  teor  |Sponsor:  Sponsor31-must
--+
Changes (by asn):

 * reviewer:   => teor


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by nickm):

 * status:  accepted => needs_review


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  nickm
 Type:  task  | Status:  accepted
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by nickm):

 * status:  needs_review => accepted
 * owner:  (none) => nickm


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  needs_review
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:  .7
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by nickm):

 * status:  new => needs_review
 * actualpoints:   => .7


Comment:

 I've attached a second file, proposing to standardize on certain
 abbreviations, add new ones, and decline to abbreviate other things.  I'm
 hoping that we come up with a good compromise between readability and
 terseness, though I recognize that no compromise will be optimal for
 everybody.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by nickm):

 * Attachment "abbrevs-proposed.txt" added.


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+

Comment (by nickm):

 I've attached a file documenting all the abbreviations that are currently
 in use in function names.  Some of them collide; some are ambiguous; some
 long terms in frequent use are missing abbreviations.

 Next steps here are to identify preferred versions (or not) for all
 ambiguous abbreviations; decide what to rectify and what to grandfather
 in; and make a (proposed) canonical list.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by nickm):

 * Attachment "abbrevs-today.txt" added.


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:  Tor: 0.4.1.x-final
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:
Parent ID:| Points:  1
 Reviewer:|Sponsor:  Sponsor31-must
--+
Changes (by gaba):

 * sponsor:   => Sponsor31-must


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

Re: [tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:
Component:  Core Tor/Tor  |Version:
 Severity:  Normal| Resolution:
 Keywords:|  Actual Points:
Parent ID:| Points:  1
 Reviewer:|Sponsor:
--+
Changes (by gaba):

 * points:  0.5 => 1


--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs

[tor-bugs] #29223 [Core Tor/Tor]: List canonical abbreviations to use in Tor functions and identifiers

[Tor Bug Tracker & Wiki]

#29223: List canonical abbreviations to use in Tor functions and identifiers
--+
 Reporter:  nickm |  Owner:  (none)
 Type:  task  | Status:  new
 Priority:  Medium|  Milestone:
Component:  Core Tor/Tor  |Version:
 Severity:  Normal|   Keywords:
Actual Points:|  Parent ID:
   Points:  0.5   |   Reviewer:
  Sponsor:|
--+
 We often don't abbreviate things in our function names and global
 identifiers.  This leads to beautiful things like
 "router_get_mutable_consensus_status_by_descriptor_digest" and
 "signed_descs_update_status_from_consensus_networkstatus" and
 "networkstatus_consensus_can_use_multiple_directories".

 What's more, when we do abbreviate, we often do so inconsistently: cfg
 versus config, con vs conn, orconn vs or_conn, and so on.

 We should specify which abbreviations we want to standardize, and converge
 on those.

 It is most important to do this for identifiers that are visible across
 modules, followed by identifiers that are global within a module. I don't
 think we need to do this for local variables.

--
Ticket URL: 
Tor Bug Tracker & Wiki 
The Tor Project: anonymity online
___
tor-bugs mailing list
tor-bugs@lists.torproject.org
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs