BIND 10 #1012: Document BIND-10 message codes

[BIND 10 Development]

#1012: Document BIND-10 message codes
-------------------------------------+-------------------------------------
                   Reporter:         |                 Owner:  jreed
  stephen                            |                Status:  reviewing
                       Type:  task   |             Milestone:
                   Priority:  major  |  Sprint-20110628
                  Component:         |            Resolution:
  documentation                      |             Sensitive:  0
                   Keywords:         |           Sub-Project:  DNS
            Defect Severity:  N/A    |  Estimated Difficulty:  0.0
Feature Depending on Ticket:         |           Total Hours:  0
        Add Hours to Ticket:  0      |
                  Internal?:  0      |
-------------------------------------+-------------------------------------

Comment (by stephen):

 > system_messages.py is in the tools directory but these are not included
 in the tarball. If a user wants to regenerate it should be included. Even
 if included in the tarball, I do not think this requires any type of test,
 but if it did, it could be very simple.
 Is it something we want to distribute?  I was thinking that this is just a
 short-cut to produce part of the documentation and that we would
 distribute it in the same way.

 > Should the tarball include the XML? The HTML? I think yes for HTML,
 maybe XML does not matter. Since they can regenerate (if they have
 system_messages.py).
 If we distribute the XML for the manual then yes, we should distribute the
 XML for this.

 > Maybe the XML should have different sections for each PREFIX (module
 type).
 We can do this - the problem is getting some sort of introductory section
 for each prefix.  Where do we put that?  (Especially as at some time in
 the future we may have several different prefixes in the same message
 file.)

 > I'd like an option to not include the abstract, XML headers, chapters so
 I can embed this XML easily into the guide itself. (That option would be
 useful for test if that was desired too.)
 At the moment everything is hard-coded into code.  I can modify it so that
 all the section information is in some form of template file.  We could
 then set up different templates for different circumstances.

 > Maybe system_messages.py should have a sh-bang #! line at top. But then
 it would need to know path or correct name of the python to use. See
 bindctl_main.py.in (and configure.ac) for example.
 I'll do this.

 This ticket is still assigned to you - are you finished reviewing?

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