BIND 10 #2230: perfdhcp Documentation

[BIND 10 Development]

#2230: perfdhcp Documentation
-------------------------------------+-------------------------------------
                   Reporter:         |                 Owner:  stephen
  stephen                            |                Status:  reviewing
                       Type:  task   |             Milestone:  Sprint-
                   Priority:         |  DHCP-20120917
  medium                             |            Resolution:
                  Component:         |             Sensitive:  0
  documentation                      |           Sub-Project:  DHCP
                   Keywords:         |  Estimated Difficulty:  0
            Defect Severity:  N/A    |           Total Hours:  0
Feature Depending on Ticket:         |
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
Changes (by marcin):

 * owner:  marcin => stephen


Comment:

 Replying to [comment:4 stephen]:
 > Reviewed commit 8f915dfd4719f03ba41c58b0524ab05054e0628c
 >
 > '''dhcp-perf-guide.xml'''[[BR]]
 > Good introduction.  We will need to extend it with more examples, but
 not just yet - that can wait until we get experience of using perfdhcp
 ourself.
 >
 > I've made a number of editorial changes - English, phrasing etc. - and
 pushed the result.
 >
 > I've also altered the text of the introduction - this is being pushed as
 a test tool, and so the text does not need anything about elimintaing bugs
 or trying out new DHCP designs.

 I am not convinced. The purpose of the test tool is to find bugs and
 correct them. It is useless to find the bug/performance bottle neck if
 you're not planning to fix it. Also I claim that it may be useful to try
 different designs based on results we get from perfdhcp.

 >
 > I've also moved the description of perfdhcp as a relay before the
 example that talks about setting port numbers (and which also refers to
 relays).
 >
 > The only thing I found lacking was in the description of template files.
 What is missing is:
 >
 > * Indication that the -T option can be specified multiple times, for (in
 order) outgoing DISCOVER/REQUEST or SOLICIT/REQUEST packets.

 I added some extra description.

 > * Format of the file.  In some cases the text says that the file
 contains binary and in other cases it contains hexadecimal digits.

 I replaced word "binary" with something more appropriate.

 > * Use of -O: the help text describes it as "Offset of last octet to
 randomise in the template".  Does this mean that everying in the packet up
 to that octet is randomised?  How is a specified byte randomised (as
 opposed to a two- or four- byte integer)?  If I randomise client ID, is
 the number of random values controlled by -R?

 I agree this is confusing. I added paragraph to explain that more
 throughly.

 > * Does the template file contain just one template?  If multiple
 templates are specified in the file, are they used in order?

 One template-file specifies exactly one packet template. I added some note
 regarding it.

 >
 > '''perfdhcp-classes.xml'''[[BR]]
 > The text is OK, but I envisaged it as being in Doxygen format and
 forming part of the BIND 10 Developers' guide.

 Thanks. Nice work. I think it looks better now.

 >
 > I've created branch trac2230-doxygen that contains the text formatted in
 Doxygen format: check out this branch and after configuring the system,
 "cd" to the "doc" directory and issue the command "make devel" to run
 Doxygen.  The Doxygen document can be seen by opening "html/index.html" in
 any browser: the perfdhcp entry will be found in the "BIND 10 Developer's
 Guide" section.
 >
 > If you're happy with this change, merge trac2230-doxygen into trac2230.

 Instead of merging I cherry-picked this commit. The commits history will
 look cleaner if we have one branch instead of two.

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