[Author Prev][Author Next][Thread Prev][Thread Next][Author Index][Thread Index]

Re: [tor-bugs] #22695 [Metrics/metrics-lib]: descriptor file processing

#22695: descriptor file processing
---------------------------------+-----------------------------------
 Reporter:  iwakeh               |          Owner:  metrics-team
     Type:  defect               |         Status:  new
 Priority:  High                 |      Milestone:  metrics-lib 2.0.0
Component:  Metrics/metrics-lib  |        Version:
 Severity:  Normal               |     Resolution:
 Keywords:                       |  Actual Points:
Parent ID:                       |         Points:
 Reviewer:                       |        Sponsor:
---------------------------------+-----------------------------------

Comment (by karsten):

 I'm not sure whether we need to do anything at all here. The JavaDocs
 specify what the two parameters are used for:

 {{{
    * @param descriptorFile Optional descriptor file reference included in
    *     parsed/unparseable descriptors
    * @param fileName Descriptor file name used for parsing the descriptor
    *     publication time of some descriptor types
 }}}

 Basically, there is no formal relationship between the two parameters. In
 many cases `fileName` will be the same as `descriptorFile.getName()`, but
 that's not required. The two parameters are used for very different
 purposes.

 And ideally we'd get rid of `fileName` anyway and only keep the optional
 `descriptorFile`. But that's for later.

 So, I don't see a bug here (yet). I do see an interface that could be
 designed more clearly. But I think the best way to get there is to throw
 out `fileName` as soon as we can.

 What do you think needs to be done here?

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/22695#comment:5>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online
_______________________________________________
tor-bugs mailing list
tor-bugs@xxxxxxxxxxxxxxxxxxxx
https://lists.torproject.org/cgi-bin/mailman/listinfo/tor-bugs