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

[Alexander Traud]

Attention is currently required from: George Joseph.
Alexander Traud 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: 
> That's the situation today.

No. The situation today is that any warnings are written *only* to the .log. They do not appear in the console at all. Furthermore, the situation today is that the Makefile unintentionally writes its own comments to the console. Finally, the situation today is that the ‘Doxyfile.in’ contains deprecated configurations. Only those warnings are printed to the console.

> The whole point of this review is to get someone to do something about the
> warnings right? 

No. The warnings are all fixed by now, at least those 2369 which I were able to find. The point of this change is to fix the issues above, and as a side-effect move the warnings from the log to the console because that .log concept did not work. Furthermore, I re-enable some warnings because they were disabled nine years ago probably because of a wrong configuration file upload as part of another change. Finally, I enable warnings for internal documentation (developer mode) and enable warnings for all undocumented things (noisy). The benefit of that is, that any new Doxygen user does not have to wade through thousands of warnings but can concentrate on his newly added ones. So it is about future warnings.

> we could remind folks via […] asterisk-dev list that if they create or change
> doxygen comments, they should run "make progdocs"

OK. Yes, that was my plan, after this is submitted.

> they're still going to get lost in the normal output

As of today, they are not there, just in the doxygen.log. And even that is incomplete because warnings got disabled or not parsed like internal docs.

> Search what?

‘warning:’ or better ‘: warning: ’

> If you can find a way to reduce doxygen and dot's verbosity to just a handful
> of progress messages, that would be better.

That is a change on top of this change actually. A plus to this change here. As of today, those messages are printed. I just *added* the warnings.

Doxygen offers the possibility of QUIET=YES. That prints *just* warnings then, which is alternative D. On my computer 'make progdocs' needs 65 seconds on a second run, a ten year old computer but with an SSD.

You do not like that either. Then, I re-create the doxygen.log, leave the console output as is, but add a note to the Makefile/console, after Doxygen was executed, that any warnings can be found in doxygen.log.



-- 
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: George Joseph <gjoseph at digium.com>
Gerrit-Comment-Date: Tue, 07 Dec 2021 16:34:06 +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/db5976a6/attachment.html>