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

Doxygen error when running v1.9.0 on macOS

      I ran into the below Doxygen error when attempting to generate the top-level landing doc page, on my MacBook with doxygen v1.9.0. We need to understand and address this issue.

      $ sh s_docs -l
      cat: top/Doxyfile.9: No such file or directory
      warning: ignoring unsupported tag 'SHOW_HEADERFILE' at line 637, file -
      warning: ignoring unsupported tag 'WARN_IF_INCOMPLETE_DOC' at line 853, file -
      warning: ignoring unsupported tag 'FULL_SIDEBAR' at line 1580, file -
      warning: ignoring unsupported tag 'MATHJAX_VERSION' at line 1661, file - 
      
      $ doxygen -v
      1.9.0
      
      $ uname -a
      Darwin M-C02ZW0ZMLVDM.local 21.4.0 Darwin Kernel Version 21.4.0: Fri Mar 18 00:45:05 PDT 2022; root:xnu-8020.101.4~15/RELEASE_X86_64 x86_64
      

      As a workaround, I downloaded and called v1.8.17 binary. Then I ran into the below error, due to the appending hash string in the "doxygen -v" output. 

      $ doxygen -v
      1.8.17 (b5fa3cd1c6e6240e20d3b80a70e3f04040b32021)
      
      $ sh s_docs -l
      s_docs skipped: unsupported version of doxygen: 1.8.17 (b5fa3cd1c6e6240e20d3b80a70e3f04040b32021), not 1.8.17 or 1.9.XX 

      The below change will make the version check more tolerant. It would be nice to cover it in this ticket as well.

      diff --git a/dist/s_docs b/dist/s_docs
      index 618f0d048..58f444ff5 100755
      --- a/dist/s_docs
      +++ b/dist/s_docs
      @@ -205,7 +205,7 @@ EOF
       # Do not build the documentation if doxygen version is not compatible.
       v=$(doxygen --version)
       case "$v" in
      -    1.8.17) doxyfile="Doxyfile";;
      +    1.8.17*) doxyfile="Doxyfile";;
           1.9.*) doxyfile="Doxyfile.9";;
           *)
               echo "$0 skipped: unsupported version of doxygen: $v, not 1.8.17 or 1.9.XX"

            Assignee:
            backlog-server-storage-engines [DO NOT USE] Backlog - Storage Engines Team
            Reporter:
            luke.chen@mongodb.com Luke Chen
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: