[Asterisk-code-review] progdocs: Update Makefile. (asterisk[16])

[George Joseph]

Attention is currently required from: Alexander Traud.
George Joseph has posted comments on this change. ( https://gerrit.asterisk.org/c/asterisk/+/17578 )

Change subject: progdocs: Update Makefile.
......................................................................


Patch Set 3:

(1 comment)

Patchset:

PS3: 
> So, you want to see the warnings. And your suggestion is to bring back doxygen.log. I have to understand that first. That is the reason for the -1. And that is your suggestion to solve the -1. Correct?

Yes.  The whole point of this review is to get someone to do something about the warnings right?  If the warnings are lost in all the other output from doxygen, no one will see them.  That's the situation today.  If you produce more warnings, they're still going to get lost in the normal output.

> What do you mean with Wiki, update the Wiki about make progdocs and add there that a doxygen.log is generated?

I meant that we could remind folks via the Wiki and asterisk-dev list that if they create or change doxygen comments, they should run "make progdocs" and examine 
doxygen.log for issues.

 
> I fixed this issue in around a dozen projects, and none of them worked with a logfile, some even bigger (and with much more output in Doxygen) then Asterisk. You do not even have to save/pipe the output, just search. 

Search what?

> a) bring back doxygen.log and place an echo in the Makefile that there is a doxygen.log?

Yes.

> b) now that we have zero warnings (right now), what about error on first warning b1) in Developer Mode b2) in general?

This could mess up build scripts that aren't expecting the failure.

> c) filter the output of Doxygen via the Makefile via your proposed sed and display that.

> d) In he Makefile, I could redirect stdout to nowhere and just display stderr.

The reason I suggested the filter was because the generation process takes so long. If there are no progress messages at all, you won't know what's happening.  If you can find a way to reduce doxygen and dot's verbosity to just a handful of progress messages, that would be better.  In fact, I forgot about filtering dot's output in my sed command.

sed -r -e "/(Reading|Searching|Parsing|Preprocessing|(Generating (docs|code))|Running dot|Patching output)/d"

To summarize...
We need to keep doxygen.log with warnings and errors.
We need to reduce the console output to higher level progress messages with either the filter or by telling doxygen and dot to not produce so much.



-- 
To view, visit https://gerrit.asterisk.org/c/asterisk/+/17578
To unsubscribe, or for help writing mail filters, visit https://gerrit.asterisk.org/settings

Gerrit-Project: asterisk
Gerrit-Branch: 16
Gerrit-Change-Id: I4129092a199d5e24c319a09cd088614b121015af
Gerrit-Change-Number: 17578
Gerrit-PatchSet: 3
Gerrit-Owner: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Reviewer: Friendly Automation
Gerrit-Reviewer: George Joseph <gjoseph at digium.com>
Gerrit-Reviewer: Kevin Harwell <kharwell at digium.com>
Gerrit-Attention: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Comment-Date: Tue, 07 Dec 2021 15:43:49 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: No
Comment-In-Reply-To: George Joseph <gjoseph at digium.com>
Comment-In-Reply-To: Alexander Traud <pabstraud at compuserve.com>
Gerrit-MessageType: comment
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-code-review/attachments/20211207/19471f81/attachment-0001.html>