Re: [Doxygen-develop] [PATCH] Add TREAT_WARNINGS_AS_ERROR option

[Adrian M N. <gr...@gm...>]

On Thu, Dec 3, 2015 at 10:34 PM, Gautier <ga...@da...> wrote:
> Hi list;
>
> As stated on Github[1], I would like to add an option behaving similarly
> to compilers' -Werror option: any warning generated during Doxygen
> execution will abort it immediately.
>
> This option is, in my opinion, valuable to keep documentation up-to-date
> with code changes, specially when multiple people are working altogether.
> I will not blame anyone to not think all consequence of a code change,
> but scripts can help him/her from breaking anything:
>
> * strict compiler options (-Werror, -Wall, etc.) prevents at least some
> quick&dirty code and obvious bugs. Compilers will warn beginners about
> code which will not work (out of bounds errors, etc.), but most of the
> time it's simply about a typo / useless dead code.
> * Git hook preventing users from pushing invalid commits [2]. We are
> intensively using git submodules for instance - it's quite easy to push
> an invalid submodule reference to git:
>      * if you forgot to run "git submodule update --recursive" after
> pulling remote changes following by a "git commit -a", leading to
> unwilling submodule downgrading.
>      * if you're referencing a new submodule revision... which you
> forgot to push first!
> * To have better code consistency, following a single code style using
> clang-format[3], similarly to what systemd does[4].

+1

This also helps in case the INPUT directory is invalid.
Right now you get:
    warning: source SOME_PATH is not a readable file or directory... skipping.

For a single project, it's easy to spot the invalid INPUT, but for
large/er projects
you're back to grep-in for "warning:"