BIND 10 #2808: duplicate IDs in bind10-messages.xml

[BIND 10 Development]

#2808: duplicate IDs in bind10-messages.xml
---------------------------------------+----------------------------------
                   Reporter:  jreed    |                 Owner:
                       Type:  defect   |                Status:  new
                   Priority:  medium   |             Milestone:  New Tasks
                  Component:  logging  |              Keywords:
               CVSS Scoring:           |             Sensitive:  0
            Defect Severity:  N/A      |           Sub-Project:  Core
Feature Depending on Ticket:           |  Estimated Difficulty:  0
        Add Hours to Ticket:  0        |           Total Hours:  0
                  Internal?:  0        |
---------------------------------------+----------------------------------
 tools/system_messages.py function processAllFiles looks for all .mes files
 under the directory passed to it on the command-line. So it will include
 other .mes files that may be in same location.

 This resulted in having duplicate IDs in the documentation for every ID
 for my build. This accident was shipped with the 1.0.0 release. While I
 should have had a more clean build tree. (I aborted a distcheck which left
 the duplicate source directory, generated the bind10-messages.xml and
 html, and ran a new distcheck which removed the old directory first.)
 This problem could happen to others different ways.

 My suggestions:

 1) The script says "However, this is an error - each ID should be unique
 in BIND-10."  So make the script error instead of appending the duplicates
 (n) like it does now.

 or:

 2) list all the know .mes files and only use them. This would be useful
 also so we can use make rules to regenerate the document if and only if
 one of them changed. The problem with this is we may forget to maintain
 the list. Currently there are around 35 message files.

 or:

 3) make the document generation per component. This would be useful
 especially since in the long run we would want the documents per different
 release tarballs (for example dhcp-libraries shouldn't ship docs for
 b10-auth log messages). But for an all-in-one release like we have now, we
 can include them all into one huge document again, but would need the list
 of each again (as above).

 It would be nice if these docs were available via a tool (like bindctl) by
 the way.

-- 
Ticket URL: <http://bind10.isc.org/ticket/2808>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development