BIND 10 #2566: Convert logging README to Doxygen format

BIND 10 Development do-not-reply at isc.org
Sun Jan 5 08:31:05 UTC 2014


#2566: Convert logging README to Doxygen format
-------------------------------------+-------------------------------------
            Reporter:  stephen       |                        Owner:
                Type:  enhancement   |  stephen
            Priority:  low           |                       Status:
           Component:                |  reviewing
  documentation                      |                    Milestone:
            Keywords:                |  Sprint-20131015
           Sensitive:  0             |                   Resolution:
         Sub-Project:  DNS           |                 CVSS Scoring:
Estimated Difficulty:  3             |              Defect Severity:  N/A
         Total Hours:  0             |  Feature Depending on Ticket:
                                     |          Add Hours to Ticket:  0
                                     |                    Internal?:  0
-------------------------------------+-------------------------------------
Changes (by kean):

 * owner:  kean => stephen


Comment:

 I have made a commit (e1b65fae14a725bd7d162517750445bf03b3f179) with a few
 small changes. Please review.

 On line 482 where you discuss the Python rules for Makefile.am, are you
 sure that doesn't require the same syncrhonisation trick used for C++
 messages? I don't think it does but it's worth checking.

 On line 578 there is a dangling paragraph in the middle of an ordered list
 that is not a list item. How will this render?

 Starting on line 603 where the arguments for the C++ initialization are
 discussed, this seems like a good candidate for using a definition list
 (<dl>) rather than using manual formatting and <b> etc. I contend that a
 definition list will render better. Similarly the next bit (variant #2)
 where discussing the environment variables, and then the Python bit, when
 describing the parameters.

 Line 703 consider replacing the word "borne" with "kept". Its more
 "American-friendly". In the same paragraph consider not having the last
 sentence parenthesised, which avoids the not-so-kosher parentheses-within-
 parentheses thing.

 Line 710 in the subsection heading. Consier using "vs." rather than just
 "v".

 On line 720 where you discuss the two work-around approaches, consider
 making that an ordered list so that the two work-arounds are numbered (and
 visually indented when rendered).

-- 
Ticket URL: <http://bind10.isc.org/ticket/2566#comment:6>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development


More information about the bind10-tickets mailing list