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

Identify and fix references to non-existent functions in documentation

    XMLWordPrintable

    Details

    • Type: Bug
    • Status: Open
    • Priority: Major - P3
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: Backlog
    • Component/s: None
    • Labels:

      Description

      In rare occasions, there are references in the documentation to API names that do not exist.  For example, in the custom data source page, if you search for "WT_SESSION::msg_printf" and "WT_EXTENSION_API::config", you'll see that these strings exist, but there is no link, since there are no functions by those names.

      Ideally, we'd not only fix these, but put into place a way to identify such broken references.  Here's a loose way to narrow the search:

      $ (cd dist; bash s_docs)
      $ (cd docs/; grep '[^>]WT_[A-Z_]*::' *.html | grep -v memname

      This is nowhere close to perfect - it generates lots of false positives. For example, in upgrading.html it discusses that WT_SESSION::msg_printf has been removed from the API, so of course there wouldn't be a link.

      If we can't enforce checking for broken references, we should at least scan and fix any we see using the method above or some other reliable method.

        Attachments

          Activity

            People

            Assignee:
            backlog-server-storage-engines Backlog - Storage Engines Team
            Reporter:
            donald.anderson Donald Anderson
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Dates

              Created:
              Updated: