commit b1083584c752398056a591fb9b342f4e58e6b172
parent d3e547b2bd93a5e43e90bda144971e243e092a57
Author: Nick Mathewson <nickm@torproject.org>
Date: Wed, 6 Nov 2019 16:59:41 -0500
Clarify that "missing-doc-warnings" makes doxygen warnings nonfatal
Diffstat:
2 files changed, 3 insertions(+), 2 deletions(-)
diff --git a/changes/ticket32385 b/changes/ticket32385
@@ -2,4 +2,5 @@
- Our "make doxygen" target now respects --enable-fatal-warnings by
default, and does not warn about items that are missing documentation.
To warn about missing documentation, run configure with the
- "--enable-missing-doc-warnings" flag. Closes ticket 32385.
+ "--enable-missing-doc-warnings" flag: doing so suspends fatal warnings
+ for doxygen. Closes ticket 32385.
diff --git a/configure.ac b/configure.ac
@@ -77,7 +77,7 @@ AC_ARG_ENABLE(pic,
AS_HELP_STRING(--enable-pic, [Build Tor's binaries as position-independent code, suitable to link as a library.]))
AC_ARG_ENABLE(missing-doc-warnings,
- AS_HELP_STRING(--enable-missing-doc-warnings, [Tell doxygen to warn about missing documentation.]))
+ AS_HELP_STRING(--enable-missing-doc-warnings, [Tell doxygen to warn about missing documentation. Makes doxygen warnings nonfatal.]))
if test "$enable_missing_doc_warnings" = "yes"; then
DOXYGEN_FATAL_WARNINGS=NO
