<p>N A has uploaded this change for <strong>review</strong>.</p><p><a href="https://gerrit.asterisk.org/c/asterisk/+/19474">View Change</a></p><pre style="font-family: monospace,monospace; white-space: pre-wrap;">xmldoc: Allow XML docs to be reloaded.<br><br>The XML docs are currently only loaded on<br>startup with no way to update them during runtime.<br>This makes it impossible to load modules that<br>use ACO/Sorcery (which require documentation).<br><br>This adds a CLI command to reload the XML docs<br>during runtime so that documentation can be updated<br>without a full restart of Asterisk.<br><br>ASTERISK-30289 #close<br><br>Change-Id: I4f265b0e5517e757c5453a0f241201a5788d3a07<br>---<br>A doc/CHANGES-staging/xmldoc.txt<br>M main/xmldoc.c<br>2 files changed, 77 insertions(+), 10 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;">git pull ssh://gerrit.asterisk.org:29418/asterisk refs/changes/74/19474/1</pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/CHANGES-staging/xmldoc.txt b/doc/CHANGES-staging/xmldoc.txt</span><br><span>new file mode 100644</span><br><span>index 0000000..50324e4</span><br><span>--- /dev/null</span><br><span>+++ b/doc/CHANGES-staging/xmldoc.txt</span><br><span>@@ -0,0 +1,5 @@</span><br><span style="color: hsl(120, 100%, 40%);">+Subject: xmldocs</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+The XML documentation can now be reloaded without restarting</span><br><span style="color: hsl(120, 100%, 40%);">+Asterisk, which makes it possible to load new modules that</span><br><span style="color: hsl(120, 100%, 40%);">+enforce documentation without restarting Asterisk.</span><br><span>diff --git a/main/xmldoc.c b/main/xmldoc.c</span><br><span>index f924717..565ad59 100644</span><br><span>--- a/main/xmldoc.c</span><br><span>+++ b/main/xmldoc.c</span><br><span>@@ -2860,13 +2860,13 @@</span><br><span> </span><br><span> static struct ast_cli_entry cli_dump_xmldocs = AST_CLI_DEFINE(handle_dump_docs, "Dump the XML docs to the specified file");</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-/*! \brief Close and unload XML documentation. */</span><br><span style="color: hsl(0, 100%, 40%);">-static void xmldoc_unload_documentation(void)</span><br><span style="color: hsl(120, 100%, 40%);">+static char *handle_reload_docs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a);</span><br><span style="color: hsl(120, 100%, 40%);">+static struct ast_cli_entry cli_reload_xmldocs = AST_CLI_DEFINE(handle_reload_docs, "Reload the XML docs");</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static void xmldoc_purge_documentation(void)</span><br><span> {</span><br><span> struct documentation_tree *doctree;</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- ast_cli_unregister(&cli_dump_xmldocs);</span><br><span style="color: hsl(0, 100%, 40%);">-</span><br><span> AST_RWLIST_WRLOCK(&xmldoc_tree);</span><br><span> while ((doctree = AST_RWLIST_REMOVE_HEAD(&xmldoc_tree, entry))) {</span><br><span> ast_free(doctree->filename);</span><br><span>@@ -2874,11 +2874,20 @@</span><br><span> ast_free(doctree);</span><br><span> }</span><br><span> AST_RWLIST_UNLOCK(&xmldoc_tree);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+/*! \brief Close and unload XML documentation. */</span><br><span style="color: hsl(120, 100%, 40%);">+static void xmldoc_unload_documentation(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli_unregister(&cli_reload_xmldocs);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli_unregister(&cli_dump_xmldocs);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ xmldoc_purge_documentation();</span><br><span> </span><br><span> ast_xml_finish();</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-int ast_xmldoc_load_documentation(void)</span><br><span style="color: hsl(120, 100%, 40%);">+static int xmldoc_load_documentation(int first_time)</span><br><span> {</span><br><span> struct ast_xml_node *root_node;</span><br><span> struct ast_xml_doc *tmpdoc;</span><br><span>@@ -2907,12 +2916,17 @@</span><br><span> ast_config_destroy(cfg);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- /* initialize the XML library. */</span><br><span style="color: hsl(0, 100%, 40%);">- ast_xml_init();</span><br><span style="color: hsl(120, 100%, 40%);">+ if (first_time) {</span><br><span style="color: hsl(120, 100%, 40%);">+ /* initialize the XML library. */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_xml_init();</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">- ast_cli_register(&cli_dump_xmldocs);</span><br><span style="color: hsl(0, 100%, 40%);">- /* register function to be run when asterisk finish. */</span><br><span style="color: hsl(0, 100%, 40%);">- ast_register_cleanup(xmldoc_unload_documentation);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (first_time) {</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli_register(&cli_dump_xmldocs);</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_cli_register(&cli_reload_xmldocs);</span><br><span style="color: hsl(120, 100%, 40%);">+ /* register function to be run when asterisk finish. */</span><br><span style="color: hsl(120, 100%, 40%);">+ ast_register_cleanup(xmldoc_unload_documentation);</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span> </span><br><span> globbuf.gl_offs = 0; /* slots to reserve in gl_pathv */</span><br><span> </span><br><span>@@ -2993,4 +3007,32 @@</span><br><span> return 0;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+int ast_xmldoc_load_documentation(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return xmldoc_load_documentation(1);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static int xmldoc_reload_documentation(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ xmldoc_purge_documentation();</span><br><span style="color: hsl(120, 100%, 40%);">+ return xmldoc_load_documentation(0);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+static char *handle_reload_docs(struct ast_cli_entry *e, int cmd, struct ast_cli_args *a)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ switch (cmd) {</span><br><span style="color: hsl(120, 100%, 40%);">+ case CLI_INIT:</span><br><span style="color: hsl(120, 100%, 40%);">+ e->command = "xmldoc reload";</span><br><span style="color: hsl(120, 100%, 40%);">+ e->usage =</span><br><span style="color: hsl(120, 100%, 40%);">+ "Usage: xmldoc reload\n"</span><br><span style="color: hsl(120, 100%, 40%);">+ " Reload XML documentation\n";</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ case CLI_GENERATE:</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+ }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ xmldoc_reload_documentation();</span><br><span style="color: hsl(120, 100%, 40%);">+ return CLI_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> #endif /* AST_XML_DOCS */</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.asterisk.org/c/asterisk/+/19474">change 19474</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.asterisk.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.asterisk.org/c/asterisk/+/19474"/><meta itemprop="name" content="View Change"/></div></div>
<div style="display:none"> Gerrit-Project: asterisk </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I4f265b0e5517e757c5453a0f241201a5788d3a07 </div>
<div style="display:none"> Gerrit-Change-Number: 19474 </div>
<div style="display:none"> Gerrit-PatchSet: 1 </div>
<div style="display:none"> Gerrit-Owner: N A <asterisk@phreaknet.org> </div>
<div style="display:none"> Gerrit-MessageType: newchange </div>