Skip to content

Fix doxygen in cmake #5768

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.

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

Conversation

hannes-steffenhagen-diffblue
Copy link
Contributor

This has been broken for 3 years, ever since doxygen.cfg was renamed to
doxyfile. This lets us build documentation in from cmake with the 'doc'
target. One difference to the previous version (i.e. the one that was
broken before) is that this creates the documentation in the cmake
binary directory now instead of the source directory. Reasoning for this
is that cmake targets should not change files in the source directory
ideally.


Not addressed here: I think this is probably the wrong place to do doxygen stuff anyway, we're referring to files outside this directory which is somewhat unfortunate.

  • Each commit message has a non-empty body, explaining why the change was made.
  • Methods or procedures I have added are documented, following the guidelines provided in CODING_STANDARD.md.
  • The feature or user visible behaviour I have added or modified has been documented in the User Guide in doc/cprover-manual/
  • Regression or unit tests are included, or existing tests cover the modified code (in this case I have detailed which ones those are in the commit message).
  • My commit message includes data points confirming performance improvements (if claimed).
  • My PR is restricted to a single feature or bugfix.
  • White-space or formatting changes outside the feature-related changed lines are in commits of their own.

This has been broken for 3 years, ever since doxygen.cfg was renamed to
doxyfile. This lets us build documentation in from cmake with the 'doc'
target. One difference to the previous version (i.e. the one that was
broken before) is that this creates the documentation in the cmake
binary directory now instead of the source directory. Reasoning for this
is that cmake targets should not change files in the source directory
ideally.
@tautschnig
Copy link
Collaborator

@hannes-steffenhagen-diffblue Would you mind adding a test by invoking the target from one of the GitHub actions that use cmake?

@hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue requested a review from a team as a code owner January 19, 2021 15:31
@hannes-steffenhagen-diffblue
Copy link
Contributor Author

@tautschnig how about that?

@codecov
Copy link

codecov bot commented Jan 19, 2021

Codecov Report

Merging #5768 (b480661) into develop (0f57d77) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop    #5768   +/-   ##
========================================
  Coverage    69.65%   69.65%           
========================================
  Files         1243     1243           
  Lines       100843   100843           
========================================
  Hits         70243    70243           
  Misses       30600    30600           
Flag Coverage Δ
cproversmt2 43.39% <ø> (ø)
regression 66.56% <ø> (ø)
unit 32.20% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0f57d77...b480661. Read the comment docs.

- name: Check that doc task works
run: |
cd build
ninja doc
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit pick: ninja -C build doc will do the same in a single line.

Copy link
Contributor

@NlightNFotis NlightNFotis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me

@hannes-steffenhagen-diffblue hannes-steffenhagen-diffblue merged commit 7d2ce20 into diffblue:develop Jan 22, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants