Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

29223: [skip ci] WIP: HACKING: proposed abbreviations for review #963

Closed
wants to merge 1 commit into from

Conversation

Labels
None yet
Projects
None yet
4 participants
@teor2345
Copy link
Contributor

@teor2345 teor2345 commented Apr 17, 2019

See 29223.

Copy link
Contributor Author

@teor2345 teor2345 left a comment

This is the first half of my review.

I wonder how much we need to distinguish between forms of speech.
Let's standardise on one word, and then use more later if we need to?

accel

accounting:
acct # proposed
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

How do we distinguish "account" and "accounting"?
Do we need to?
acct vs acctng?

ack

activate, active, activity:
???
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

actvt, actv, actv(t)y?

Also action, which maybe should be:
actn

adj

advertise, advertised:
# switch to American spelling.
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

Do we also need abbreviations?
advt, advtd?

alloc # proposed

annotation:
anno
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

Means "year" in many languages.
antn?

arg

array:
???
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

arr?

distr

distributor:
dist
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

Duplicate line

enc

encrypted:
???
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

encd

esc

escaped:
??? # proposed: no abbreviation
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

escd

ewma

extend:
ext??? # deprecate; too ambiguous
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

extd

ei

field:
??? # proposed: no abbreviation
Copy link
Contributor Author

@teor2345 teor2345 Apr 17, 2019

fld?

Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Probably not, actually. The abbreviation is too confusing.

gcd

handle:
hnd # proposed
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Not immediately obvious.

hndl

Copy link
Contributor Author

@teor2345 teor2345 left a comment

I think these abbreviations would be easier to read and search if we split them up into subject areas

hnd # proposed

handshake:
??? # proposed: no abbreviation
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

hndshk ?

ht

hexadecimal:
hex
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

I suggest we merge this with base 16?

hex

hibernate, hibernating, hibernation:
??? # proposed: rename entirely; it gets confused with dormancy.
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

The torrc options start with Accounting, so maybe we should rename them to something like:

  • hibernate - accounting_soft_limit_act / accounting_hard_limit_act
  • is_hibernating - accounting_soft_limit_reached / accounting_hard_limit_reached
  • hibernating - accounting_soft_limit_act / accounting_hard_limit_act
  • hibernation - accounting

We might need some other variants in different contexts.

??? # proposed: rename entirely; it gets confused with dormancy.

hidden service:
hs
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Deprecate, replace with onion service?

Copy link
Member

@asn-d6 asn-d6 Apr 23, 2019

Yes, I think this is an important missing piece. Is it fine to still abbreviate 'onion service' as 'hs'? Because we are clearly doing it.

Copy link
Contributor Author

@teor2345 teor2345 Apr 24, 2019

I honestly don't mind.

I think "hs" is a fine abbreviation for code and names that users never see.
The abbreviations for onion service are all longer, because "os" means "operating system".

hs

histogram:
hist
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Conflicts with history?

histgm ?

rtt

router:
??? # proposed: no abbreviation
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

rtr ?

Copy link
Contributor

@tlyu tlyu May 3, 2019

I think rtr is common in some operational contexts

sb # only in sandbox code.

second, secret, secure, security:
sec # too overloaded?
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Yes.

sec for second.

secr for secret, secure, security

serv

service:
??? # proposed: no abbrev?
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

svc ?

Copy link
Contributor

@tlyu tlyu May 3, 2019

Yes, svc is commonplace, e.g., SUNRPC.

tmp

timeout:
??? # proposed: no abbreviation, or say "delay" instead?
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

delay doesn't work for END_OR_CONN_REASON_TIMEOUT

Copy link
Contributor

@tlyu tlyu May 3, 2019

I've maybe seen to or maybe timo, depending on context?

uniq

unmeasured bandwidth:
umbw
Copy link
Contributor Author

@teor2345 teor2345 Apr 22, 2019

Do we also need:
mbw measured bandwidth

@teor2345 teor2345 changed the title [skip ci] WIP: HACKING: proposed abbreviations for review 29223: [skip ci] WIP: HACKING: proposed abbreviations for review Apr 22, 2019
@torproject-pusher torproject-pusher deleted the branch torproject:master May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment