BIND 10 #2305: Document bindctl in the BIND 10 guide

[BIND 10 Development]

#2305: Document bindctl in the BIND 10 guide
-------------------------------------+-------------------------------------
                   Reporter:  jreed  |                 Owner:  jinmei
                       Type:         |                Status:  reviewing
  defect                             |             Milestone:
                   Priority:         |  Sprint-20121120
  medium                             |            Resolution:
                  Component:  bind-  |             Sensitive:  0
  ctl                                |           Sub-Project:  Core
                   Keywords:         |  Estimated Difficulty:  7
            Defect Severity:  N/A    |           Total Hours:  0
Feature Depending on Ticket:         |
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------
Changes (by jelte):

 * owner:  jelte => jinmei


Comment:

 Replying to [comment:5 jinmei]:
 > I've only gone through the text, performing sanity checks.  I didn't
 > confirm whether each and every example actually works as documented by
 > hand, for example.
 >
 > Specific comments:
 >
 > - I guess this change may be worth a changelog entry.  But I'd leave
 >   it to you.

 something simple like this ok? (not sure if i should add what the chapter
 contains)

 [doc] jelte
 Added a chapter about the use of the bindctl command tool to the BIND 10
 guide.


 > - I suggest the documentation issue of #2449 is addressed within
 >   ticket, either in the new section 7 or as part of installation.

 oh right, added a note at the beginning

 > - some concepts seem to be used before the definition, such as "named
 set".

 hmm, yes, but switching them around would have the same problem... Added a
 few references to the section.

 > - 7.6 Configuration commands: "but similar to modules" should be
 >   "but similar to commands"?

 changed

 > - 7.6.1. List of configuration commands: "must be (in JSON format)"
 >   why in parentheses?  and it doesn't seem to parse well.  Maybe
 >   "must be specified (in JSON format)"

 oops, yes, added 'specified'

 > - 7.6.2. Configuration data types: the use of ';' and ',' is not
 >   consistent.

 changed ',' to ';'

 > - maps: it doesn't explain how to remove stuff from a map.

 That's because you can't :) (a map's possible entries are pre-defined by
 the spec file, they may be optional and have no value, but they cannot be
 removed completely, at least not by the user).

 Changed a bit in the wording, and added a small paragraph to make this
 more clear

 > - the example at the last of "named set" doesn't seem to make much
 >   sense.

 oh hadn't noticed the bad formatting there. Updated (And added why these
 commands are shown)

 > - 7.7.2. Notes on execute scripts: "However; as module" should be
 >   "However, as module"?

 yup, changed

 > - 7.7.2. Notes on execute scripts: I was not sure how the second
 >   paragraph relates to execute scripts.

 ah, that was some old text that should've been removed. Removed now.

 > - there's a redundant space at the end of line:
 > {{{#!diff
 > +Module  Boss   Master process
 > }}}
 >   I'm not sure if this is an issue of XML or in the output of bindctl.
 >   In either case, the XML doc should be fixed.  If it's also a bindctl
 >   issue it should also be fixed.

 Yup, it was in the original output (due to the python syntax used)

 fixed both

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