Uploaded image for project: 'WiredTiger'
  1. WiredTiger
  2. WT-9504

Fix documentation output for specially constructed join statistics strings

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Minor - P4
    • Resolution: Fixed
    • None
    • 6.1.0-rc0, WT11.0.1
    • None
    • None

    Description

      Currently in the docs under "Statistics for join cursors" we get:

      #define  WT_STAT_JOIN_MAIN_ACCESS
        : accesses to the main table

      which in addition to being missing "join" before the colon, doesn't document that what actually comes through is "join: table:mytable: accesses to the main table".

      This is because the magic that sets up the substitution of the table/index name into the stat name is a little bit too much magic and the code that generates the descriptions into wiredtiger.in can't cope with it.

      I tried to fix this naively as part of WT-9492, but that didn't work (did not understand everything that was going on at the time) and had to revert the change there.

      I have a new change that rearranges it all slightly so that the docs come out better.

      Attachments

        Activity

          People

            donald.anderson@mongodb.com Donald Anderson
            dholland+wt@sauclovia.org David Holland
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: