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

[Kevin Harwell]

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

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


Patch Set 3: Code-Review+1

(3 comments)

Commit Message:

https://gerrit.asterisk.org/c/asterisk/+/17578/comment/0caf25f6_f2441f2f 
PS2, Line 22: ASTERISK-26991
> Looking at what I said now, I am not sure about the advertisement after ‘make install’ anymore. Is that advertisement helpful? It might confuse normal users, not being API developers. Perhaps the wording should be changed from ‘program doc’ to ‘API doc’ and tell the user that the ‘usage doc’ was already built because of the XML documentation. What do you think? Perhaps even the whole make target should be removed and renamed to ‘apidoc’ or just ‘doxygen’ to be inline with the xml-doc which is a usage-doc actually.

I personally would be fine with changing the wording around that. It could certainly be made less ambiguous.

Not sure about removing the whole make target though. Perhaps in master only. Otherwise it might break current user's build and install process. Perhaps add an 'apidoc' and/or 'doxygen' target(s) in 16, 18, 19, with 'progdocs' still as an alias. Then in master could remove what you want.


Patchset:

PS3: 
Current patch looks good to me, so giving +1. However, feel free to update the after install text if you want.


File doc/.gitignore:

https://gerrit.asterisk.org/c/asterisk/+/17578/comment/172ed157_4382887d 
PS2, Line 5: asterisk-ng-doxygen
> Yes. […]
It's not a big deal to leave it, and seems like the safer route.

However, I believe items listed in .gitignore are untracked files, so removing it would make 'asterisk-ng-doxygen' show up under "Untracked files" when you issue a "git status" command. Someone would then have to do a git add and commit for it to be uploaded.



-- 
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: Kevin Harwell <kharwell at digium.com>
Gerrit-Attention: Alexander Traud <pabstraud at compuserve.com>
Gerrit-Comment-Date: Wed, 01 Dec 2021 17:09:36 +0000
Gerrit-HasComments: Yes
Gerrit-Has-Labels: Yes
Comment-In-Reply-To: Kevin Harwell <kharwell 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/20211201/dcec3273/attachment.html>