diff options
| author | Jack Lloyd <[email protected]> | 2018-07-02 11:52:10 -0400 |
|---|---|---|
| committer | Jack Lloyd <[email protected]> | 2018-07-02 11:52:10 -0400 |
| commit | a14ab32d50597c4e403278b2ca9473acd2de6cb1 (patch) | |
| tree | dfbc1350d732be7e6945c69056823aebf3b735a9 | |
| parent | d40c9bacdba37cecb0ebca78bcef31a88979bd48 (diff) | |
Avoid having Doxygen error out except in maintainer mode builds
Increases likelyhood that it will fail to build for an end user
which is not helpful for anyone.
| -rwxr-xr-x | configure.py | 1 | ||||
| -rw-r--r-- | doc/manual/cli.rst | 1 | ||||
| -rw-r--r-- | src/build-data/botan.doxy.in | 3 | ||||
| -rwxr-xr-x | src/scripts/build_docs.py | 4 |
4 files changed, 7 insertions, 2 deletions
diff --git a/configure.py b/configure.py index b09f07bb5..35be81a73 100755 --- a/configure.py +++ b/configure.py @@ -1863,6 +1863,7 @@ def create_template_vars(source_paths, build_paths, options, modules, cc, arch, 'with_rst2man': options.with_rst2man, 'sphinx_config_dir': source_paths.sphinx_config_dir, 'with_doxygen': options.with_doxygen, + 'maintainer_mode': options.maintainer_mode, 'out_dir': build_dir, 'build_dir': build_paths.build_dir, diff --git a/doc/manual/cli.rst b/doc/manual/cli.rst index 3a98894bb..22b3f01a3 100644 --- a/doc/manual/cli.rst +++ b/doc/manual/cli.rst @@ -1,5 +1,6 @@ Command Line Interface ======================================== +.. highlight:: sh Outline ------------ diff --git a/src/build-data/botan.doxy.in b/src/build-data/botan.doxy.in index bbb0bbaf7..16f681ef2 100644 --- a/src/build-data/botan.doxy.in +++ b/src/build-data/botan.doxy.in @@ -74,7 +74,10 @@ WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_FORMAT = "$file:$line: $text" WARN_LOGFILE = + +%{if maintainer_mode} WARN_AS_ERROR = YES +%{endif} #--------------------------------------------------------------------------- # configuration options related to the input files diff --git a/src/scripts/build_docs.py b/src/scripts/build_docs.py index 9b0e37960..92542dd2d 100755 --- a/src/scripts/build_docs.py +++ b/src/scripts/build_docs.py @@ -78,10 +78,10 @@ def run_and_check(cmd_line, cwd=None): logging.error("Executing %s failed (%s)", ' '.join(cmd_line), e) if stdout: - logging.debug(stdout.decode()) + logging.info(stdout.decode()) if stderr: - logging.debug(stderr.decode()) + logging.info(stderr.decode()) if proc.returncode != 0: logging.info(stdout.decode()) |