Summary:	ASTERISK-29790: xmldoc: Dump invalid to XML DTD: XSLT
Reporter:	Alexander Traud (traud)	Labels:
Date Opened:	2021-12-06 04:22:49.000-0600	Date Closed:	2021-12-13 09:11:30.000-0600
Priority:	Minor	Regression?
Status:	Closed/Complete	Components:	Documentation
Versions:	16.22.0 18.8.0 19.0.0	Frequency of Occurrence
Related Issues:
Environment:		Attachments:
Description:	After {{./configure --enable-xmldoc}}, the command-line interface (CLI) offers {{xmldoc dump <file>}} since Asterisk 12. Although {{make full}} calls the sub-target {{make validate-docs}}, just the static XML file is validated. Nobody, not even the script {{tests/CI/publishAsteriskDocs.sh}}, validated the runtime XML file against its DTD: {code} xmllint --noout --dtdvalid doc/appdocsxml.dtd <file> xmlstarlet val --err --dtd doc/appdocsxml.dtd <file> {code} gives something like {code} Value " false " for attribute required of parameter is not among the enumerated set {code} The cause is {{doc/appdocsxml.xslt}} and the whitespace around the value ‘false’ for the XML attribute called ‘required’ in the XML element called ‘parameter’. This issue was introduced in Nov. 2016 with the change for ASTERISK-26595. Looking at that timespan, what about validating the runtime XML in {{tests/CI/publishAsteriskDocs.sh}}? As solution, I opted for removing the whitespace in the XSLT itself. There could be another issue: The XSLT is imported incorrectly (whitespace not stripped). I did not look into that approach.
Comments:	By: Asterisk Team (asteriskteam) 2021-12-06 04:22:51.054-0600 Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. Please note that log messages and other files should not be sent to the Sangoma Asterisk Team unless explicitly asked for. All files should be placed on this issue in a sanitized fashion as needed. A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report. Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process]. Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur. Please note that by submitting data, code, or documentation to Sangoma through JIRA, you accept the Terms of Use present at [https://www.asterisk.org/terms-of-use/|https://www.asterisk.org/terms-of-use/]. By: Friendly Automation (friendly-automation) 2021-12-13 09:11:32.172-0600 Change 17594 merged by George Joseph: xmldoc: Avoid whitespace around value for parameter/required. [https://gerrit.asterisk.org/c/asterisk/+/17594|https://gerrit.asterisk.org/c/asterisk/+/17594] By: Friendly Automation (friendly-automation) 2021-12-13 09:11:38.081-0600 Change 17623 merged by George Joseph: xmldoc: Avoid whitespace around value for parameter/required. [https://gerrit.asterisk.org/c/asterisk/+/17623|https://gerrit.asterisk.org/c/asterisk/+/17623] By: Friendly Automation (friendly-automation) 2021-12-13 09:11:41.001-0600 Change 17624 merged by George Joseph: xmldoc: Avoid whitespace around value for parameter/required. [https://gerrit.asterisk.org/c/asterisk/+/17624|https://gerrit.asterisk.org/c/asterisk/+/17624] By: Friendly Automation (friendly-automation) 2021-12-13 09:11:43.518-0600 Change 17622 merged by George Joseph: xmldoc: Avoid whitespace around value for parameter/required. [https://gerrit.asterisk.org/c/asterisk/+/17622|https://gerrit.asterisk.org/c/asterisk/+/17622]