BIND 10 #397: Port generic red-black tree (RBT) data structure from BIND-9
BIND 10 Development
do-not-reply at isc.org
Wed Nov 10 02:51:15 UTC 2010
#397: Port generic red-black tree (RBT) data structure from BIND-9
------------------------------+---------------------------------------------
Reporter: zzchen_pku | Owner: jinmei
Type: enhancement | Status: reviewing
Priority: major | Milestone:
Component: data source | Resolution:
Keywords: | Sensitive: 0
Estimatedhours: 0.0 | Hours: 0
Billable: 1 | Totalhours: 0
Internal: 0 |
------------------------------+---------------------------------------------
Comment(by jinmei):
Replying to [comment:7 zzchen_pku]:
> > Positions of many */& are incorrect in terms of the coding guideline.
> > 'return' still miss parentheses.
> Updated.
> Please check, thanks.
>
Test coverage now looks good. I'll look into it once I'm done with the
writable data source branch.
Meanwhile, could you update the documentation more? Currently the amount
and quality of the document are not sufficient to me. I'd expect
- for each class, describe what this class is responsible for; how
generally the application uses it; non trivial implimentation decisions
(and the consequences of them, e.g. restriction of the usage); other
implementation notes; and, things like rbtree, a simple diagram how the
tree would look like.
- for each enum value or constant class variable, give a short
description of what it means
- for each member function, describe what it does; whether/when it throws
exceptions; parameters and return value in the doxygen format; other non
trivial implementation notes, if any
- same for other global functions, constant values, etc.
See the current documentation at:
http://bind10.isc.org/~jinmei/bind10-trac397/cpp/classisc_1_1datasrc_1_1_r_b_tree.html
http://bind10.isc.org/~jinmei/bind10-trac397/cpp/classisc_1_1datasrc_1_1_r_b_node.html
and compare it with, e.g., this one:
http://bind10.isc.org/~jinmei/bind10-trac397/cpp/classisc_1_1dns_1_1_e_d_n_s.html#_details
When someone says a branch is "ready for review", I normally expect the
latter level of documentation is included. This is not only for
completeness; sometimes you notice missing features or defect in the
implementation as you try to provide detailed document of the
implementation. So, it's also for maturing the implementation.
--
Ticket URL: <http://bind10.isc.org/ticket/397#comment:8>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development
More information about the bind10-tickets
mailing list