Opened 8 years ago

Closed 7 years ago

#1721 closed defect (duplicate)

generate documentation for stats items

Reported by: jreed Owned by:
Priority: low Milestone:
Component: documentation Version:
Keywords: Cc:
CVSS Scoring: Parent Tickets:
Sensitive: no Defect Severity: N/A
Sub-Project: Core Feature Depending on Ticket:
Estimated Difficulty: 0 Add Hours to Ticket: 0
Total Hours: 0 Internal?: no

Description

Spec files contain documentation for statistics items. It would be nice to generate some XML that can be reused for creating documentation for these.

As an example output:

    <variablelist>

      <varlistentry>
        <term>auth.rcode.nxrrset</term>
        <listitem><simpara>The number of total responses with rcode 8
         (NXRRSET).</simpara></listitem>
      </varlistentry>

...

Note that some item_title and item_description have different details so may need to reword some too.

As far as I see, nothing uses the title or description currently.

Subtickets

Change History (5)

comment:1 Changed 8 years ago by jreed

The shorter item_title description is used for the stats-httpd output.

comment:2 follow-up: Changed 8 years ago by naokikambe

A trivial comment. The prefix of the module name like "auth." is currently unused. According to this, we also need to update the xmls and manpages for bind10 and b10-stats.

comment:3 in reply to: ↑ 2 Changed 8 years ago by jreed

Replying to naokikambe:

A trivial comment. The prefix of the module name like "auth." is currently unused. According to this, we also need to update the xmls and manpages for bind10 and b10-stats.

Thanks. I have now updated those in commit d2e2cb97e821844dc430ef1e47d13d618c06d9fb

comment:4 Changed 8 years ago by shane

  • Milestone New Tasks deleted

comment:5 Changed 7 years ago by y-aharen

  • Resolution set to duplicate
  • Status changed from new to closed

This work will be done in #2157. Closing this ticket.

Note: See TracTickets for help on using tickets.