[riot-notifications] [RIOT-OS/RIOT] doxygen/Makefile: summarize warnings, log full output to file. (#10976)

Juan I Carrano notifications at github.com
Fri Feb 8 17:23:21 CET 2019

The RIOT community cares a lot about code quality.
Therefore, before describing what your contribution is about, we would like
you to make sure that your modifications are compliant with the RIOT
coding conventions, see https://github.com/RIOT-OS/RIOT/wiki/Coding-conventions.

### Contribution description

The latest versions of doxygen produce an unwieldy amount of warnings. Instead of ignoring them, this commit causes them to be saved to a log file in the common build directory and prints only a summary with a tally of the number of each type of warning found.

#### New logs directory

As a side effect of this change, I needed a place to place the logs. I defined BUILD_DIR/logs as that place.
Also, The definition of BUILD_DIR is moved to makefiles/buildout.inc.mk so that it can be reused by makefiles that do not include Makefile.include (such as the docs makefile).

### Testing procedure

Run `make doc` with a recent version of doxygen (I'm using 1.8.15) with and without this patch.

Without it, your screen will be flooded with warning messages. With the patch you get:

( cat riot.doxyfile ; echo "GENERATE_HTML = yes" ) | doxygen - 2>&1 1>&2 | tee /home/jcarrano/source/masterRIOT/build/logs/doxygen.log | sed -nf warning_patterns.sed | sort | uniq -c
     20 Repeated label
  12824 Undocumented member

and the file `logs/doxygen.log` will get created containing the full logs.

$ wc -l build/logs/doxygen.log
12844 build/logs/doxygen.log

### Issues/PRs references

Trying to alleviate #10815 .

You can view, comment on, or merge this pull request online at:


-- Commit Summary --

  * Makefile.include: move BUILD_DIR definition to makefiles/
  * doxygen/Makefile: summarize warnings, log full output to file.

-- File Changes --

    M Makefile.include (5)
    M doc/doxygen/Makefile (18)
    A doc/doxygen/warning_patterns.sed (6)
    A makefiles/buildout.inc.mk (14)

-- Patch Links --


You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.riot-os.org/pipermail/notifications/attachments/20190208/d22842b9/attachment.html>

More information about the notifications mailing list