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.

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

Add section to CONFIGURE.md link #1578

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Conversation

iyanmv
Copy link
Member

@iyanmv iyanmv commented Oct 13, 2023

This is a very small change so that ninja gen_docs works as expected.

Without this change, doxygen (at least, version 1.9.8) gives the following error:

unable to resolve reference to '/liboqs/CONFIGURE.md' for \ref command

This makes scripts/run_doxygen.sh return exit code 1 instead of 0, and causes ninja gen_docs to fail

  • Does this PR change the input/output behaviour of a cryptographic algorithm (i.e., does it change known answer test values)? (If so, a version bump will be required from x.y.z to x.(y+1).0.)
  • Does this PR change the list of algorithms available -- either adding, removing, or renaming? Does this PR otherwise change an API? (If so, PRs in oqs-provider, OQS-OpenSSL, OQS-BoringSSL, and OQS-OpenSSH will also need to be ready for review and merge by the time this is merged.)

Without it, doxygen (at least, version 1.9.8) gives the following error:
unable to resolve reference to '/liboqs/CONFIGURE.md' for \ref command

This makes scripts/run_doxygen.sh return exit code 1 instead of 0, and
causes `ninja gen_docs` to fail
@iyanmv iyanmv requested a review from dstebila as a code owner October 13, 2023 07:40
Copy link
Member

@baentsch baentsch left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks for the contribution!

@dstebila dstebila merged commit bac716c into open-quantum-safe:main Oct 18, 2023
20 checks passed
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.

3 participants