[asterisk-dev] [Code Review] 2469: Prevent duplication of XML blobs throughout documentation

[David Lee]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2469/#review8438
-----------------------------------------------------------


I wonder if validate-docs can (or should) validate the XML fragments?

I ran the astxml2wiki.py script myself, and was surprised it worked. Good work!


trunk/Makefile
<https://reviewboard.asterisk.org/r/2469/#comment16270>

    Rather than have a root /xml directory (which could mean anything), this should probably be a /doc/fragments/ or /doc/includes/ or /doc/include-templates/ or something that's at least descriptive.



trunk/Makefile
<https://reviewboard.asterisk.org/r/2469/#comment16268>

    Using regex to process XML frightens me.
    
    http://stackoverflow.com/a/1732454/115478



trunk/Makefile
<https://reviewboard.asterisk.org/r/2469/#comment16269>

    Some of the event docs only show up in full-en_US.xml, right? Just scanning core-en_US.xml may miss some.



trunk/xml/channel_snapshot.xml
<https://reviewboard.asterisk.org/r/2469/#comment16271>

    I'm a huge fan of putting XML in an actual XML file. +1


- David Lee


On April 24, 2013, 5:21 p.m., opticron wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2469/
> -----------------------------------------------------------
> 
> (Updated April 24, 2013, 5:21 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> Create a minimal framework for automatically generating customized XML blobs.  Currently, this is targeted at channel snapshot XML blobs since a variant with a "Dest" suffix for every parameter name is required, but there will soon be other variants that pop up with the parking code (Retreiver, Parker, Parkee) and there is at least one variant used for bridge snapshot XML blobs during bridge merges (to which this work is trivially applicable).
> 
> 
> Diffs
> -----
> 
>   trunk/Makefile 386420 
>   trunk/main/manager_channels.c 386420 
>   trunk/xml/channel_snapshot.xml PRE-CREATION 
> 
> Diff: https://reviewboard.asterisk.org/r/2469/diff/
> 
> 
> Testing
> -------
> 
> Verified that documentation is generated and dumped correctly.
> 
> 
> Thanks,
> 
> opticron
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130502/8cebfaa1/attachment-0001.htm>