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

Empty paragraph passed to '\retval' command [-Werror,-Wdocumentation] #7675

Closed
matetothpal opened this issue Jun 1, 2023 · 1 comment · Fixed by #7805
Closed

Empty paragraph passed to '\retval' command [-Werror,-Wdocumentation] #7675

matetothpal opened this issue Jun 1, 2023 · 1 comment · Fixed by #7805
Labels
bug component-docs Docs / website issues filed here for tracking good-first-issue Good for newcomers size-s Estimated task size: small (~2d)

Comments

@matetothpal
Copy link

Summary

Compiling Mbed TLS with clang >= v15 results in compilation errors.
This is an issue similar to #7146 and #6960 but this time in library/psa_crypto_ffdh.h

System information

Mbed TLS version (current development branch (0b68784)):
Operating system and version: X86_64 Ubuntu 20.04
Configuration (if not default, please attach mbedtls_config.h): default
Compiler and options (if you used a pre-built binary, please indicate how you obtained it): llvm 15.0.6
Additional environment information: -

Expected behavior

Build successfully

Actual behavior

Build error:

In file included from library/psa_crypto.c:38:
library/psa_crypto_ffdh.h:50:41: error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_ERROR_INSUFFICIENT_MEMORY
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
library/psa_crypto_ffdh.h:51:41: error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_ERROR_CORRUPTION_DETECTED
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
library/psa_crypto_ffdh.h:76:35: error: empty paragraph passed to '\retval' command [-Werror,-Wdocumentation]
 * \retval #PSA_ERROR_NOT_PERMITTED
   ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~^
...

Steps to reproduce

rm -fr build && mkdir build && pushd build && \
cmake -DCMAKE_C_COMPILER=clang .. && \
cmake --build . ; \
popd
shinchiro added a commit to shinchiro/mpv-winbuild-cmake that referenced this issue Jun 2, 2023
vapoursynth: error on generate delayload import
mbedtls: same error as Mbed-TLS/mbedtls/issues/7675
libssh & libsrt: depend on mbedtls
libzvbi: error cause by incorrect header used by architecture?
@bensze01 bensze01 added bug good-first-issue Good for newcomers component-docs Docs / website issues filed here for tracking size-s Estimated task size: small (~2d) labels Jun 7, 2023
@gilles-peskine-arm
Copy link
Contributor

This specific case was fixed in #7805.

With #7968, we do a build with Clang 16 on our CI. We aren't doing a build with -Wdocumentation yet, so we aren't yet checking that other similar cases won't sneak it, but that's planned soon. So I'm closing this issue as resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug component-docs Docs / website issues filed here for tracking good-first-issue Good for newcomers size-s Estimated task size: small (~2d)
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants