Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Missing AArch64 Doxygen INSTR_CREATE_ docs cause build failure #4106

Open
derekbruening opened this issue Feb 15, 2020 · 0 comments
Open

Missing AArch64 Doxygen INSTR_CREATE_ docs cause build failure #4106

derekbruening opened this issue Feb 15, 2020 · 0 comments
Assignees
@AssadHashmi
Labels
Component-Build Component-Docs OpSys-AArch64

Comments

@derekbruening
Copy link
Contributor

Split from #1569

With a new doxygen 1.8.17 the missing AArch64 headers cause build failure:

CMake Error at api/docs/CMake_rundoxygen.cmake:143 (message):
  *** doxygen failed: ***

  D:/derek/dr/git/build_x64_dbg_tests/include/dr_ir_macros_aarch64.h:501:
  warning: The following parameters of INSTR_CREATE_adc(dc, Rd, Rn, Rm) are
  not documented:

    parameter 'Rd'
    parameter 'Rn'
    parameter 'Rm'

  D:/derek/dr/git/build_x64_dbg_tests/include/dr_ir_macros_aarch64.h:503:
  warning: The following parameters of INSTR_CREATE_adcs(dc, Rd, Rn, Rm) are
  not documented:

    parameter 'Rd'
    parameter 'Rn'
    parameter 'Rm'

  D:/derek/dr/git/build_x64_dbg_tests/include/dr_ir_macros_aarch64.h:433:
  warning: The following parameters of INSTR_CREATE_add(dc, rd, rn,
  rm_or_imm) are not documented:

    parameter 'rd'
    parameter 'rn'
    parameter 'rm_or_imm'

  D:/derek/dr/git/build_x64_dbg_tests/include/dr_ir_macros_aarch64.h:435:
  warning: The following parameters of INSTR_CREATE_add_extend(dc, rd, rn,
  rm, ext, exa) are not documented:

    parameter 'rd'
    parameter 'rn'
    parameter 'rm'
    parameter 'ext'
    parameter 'exa'

...

I don't want to disable all such warnings because they are very useful (there were a couple of x86 ones I am fixing now as part of PR #4105). There seems to be no way to disable warnings for just one file. Maybe the best way forward is to disable these macros from appearing in the generating HTML docs at all, until their headers are added.
derekbruening added a commit that referenced this issue Feb 15, 2020
@derekbruening
Fixes a few x86 INSTR_CREATE Doxygen errors reported by the new Doxygen.
48518d5 
Suppresses documenting the many AArch64 INSTR_CREATE macros missing
headers: i#4106 covers adding the headers and remove the exclusions.

Issue: #4106
derekbruening added a commit that referenced this issue Feb 15, 2020
@derekbruening
i#4000, i#3235: Simplify documentation building (#4105)
5935119 
Removes build-time transformation from FIG to PNG or EPS and instead
checks in the PNG files for our handful of figures.  This then removes
the need for Fig2Dev, Ghostscript, and ImageMagick altogether.

Fixes Doxygen installation on Appveyor by directly downloading it
rather than trying to use Chocolatey.

Fixes identification of whether Doxygen is Cygwin or not by changing
the test to try to write to a UNIX path as the old test failed on
newer Doxygen versions.

Fixes a few x86 INSTR_CREATE Doxygen errors reported by the new Doxygen.

Suppresses documenting the many AArch64 INSTR_CREATE macros missing
headers: i#4106 covers adding the headers and remove the exclusions.

Issue: #4106
Fixes #3235
Fixes #4000
@AssadHashmi AssadHashmi self-assigned this Feb 17, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AssadHashmi AssadHashmi

Labels
Component-Build Component-Docs OpSys-AArch64
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@derekbruening @AssadHashmi