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

[opticron]

> On May 7, 2013, 2:28 p.m., Matt Jordan wrote:
> > trunk/Makefile, lines 480-487
> > <https://reviewboard.asterisk.org/r/2469/diff/2/?file=37341#file37341line480>
> >
> >     I'm with David. I worry a lot about the maintainability of scripts such as this, particularly when they're targeted at XML. Things that parse XML outside of actual XML parsers tend to be incredibly brittle.
> >     
> >     For example, we already have moved from suffixes to prefixes, so.. there's that.
> >     
> >     While I find the repetitive documentation of prefixed channel names a nuisance, this is a relatively rare and minor pain. Fixing broken XML may be more pain than simply pasting a "Foo" before a particular name and being done with it.

Maybe something will present itself in the near future as a way to better generate these XML blobs.  Until then, I'll settle for pulling the blobs themselves out into hand-generated files so they're easier to manage.


- opticron


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


On May 7, 2013, 2:09 p.m., opticron wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2469/
> -----------------------------------------------------------
> 
> (Updated May 7, 2013, 2:09 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/main/manager_channels.c 387801 
>   trunk/Makefile 387801 
>   trunk/doc/fragments/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/20130507/ef0b4086/attachment.htm>