[sr-dev] git:master: sl Minor README updates (file name changes)

[Olle E. Johansson]

20 dec 2012 kl. 21:53 skrev Daniel-Constantin Mierla <miconda at gmail.com>:

> 
> On 12/20/12 9:14 PM, Olle E. Johansson wrote:
>> 20 dec 2012 kl. 21:07 skrev Daniel-Constantin Mierla <miconda at gmail.com>:
>> 
>>> Hello,
>>> 
>>> On 12/20/12 9:00 PM, Olle E. Johansson wrote:
>>>> sl Minor README updates (file name changes)
>>>> 
>>>> ---
>>>> 
>>>>  modules/sl/README                                  |  154 ++++++++++----------
>>>>  modules/sl/doc/sl.xml                              |   16 +-
>>>>  modules/sl/doc/{functions.xml => sl_functions.xml} |    0
>>>>  modules/sl/doc/{params.xml => sl_params.xml}       |    0
>>>>  modules/sl/doc/{stats.xml => sl_stats.xml}         |    0
>>> is this rename necessary for some reason? I see you started doing it to many modules.
>>> 
>>> The point is that it breaks the script that generates the alphabetic indexes.
>> Ouch. Different modules seems to have different naming and XML formatting ideas
> The name patterns were two so far (I normalized them when I built the indexing script):
> 
> 1) old kamailio style: modname.xml, modname_admin.xml, modname_devel.xml and modname_faq.xml. The first two are most common, modname.xml with the header, modname_admin.xml with top description, functions/params/mi cmds/etc.. usable from config
> 
> 2) old ser style: modname.xml, functions.xml, params.xml, etc... Each file contains parts of what is modname_admin.xml in kamailio style
> 
Right.

>> 
>> Another reason is that I want to aggregate the files and produce a combined documentation set and the way I have been playing with doesn't work with the same file names - like "params.xml" for multiple modules. Since many modules had modname_params.xml
> 
> I don't recall modname_params.xml being used so far (modules/ and modules_k/ were indexed so far for sure), which modules had it?
I think I came up with that based on functions and others. Made sense. But I could combine them into <name>_admin.xml
> 
>>  I decided to start moving the xml file names to a standard way.
> 
> At the end I wouldn't be against of having a (new) 'standard' way, but it has to be defined with some clear patterns/rules, because what you started to use as new name was not a 'standard' pattern so far.
Ok. What's the proposal? I would prefer kamailio style file names and <book> as the main item in the <modname>.xml file.

/O
> 
>> 
>> Sorry for causing trouble.
>> 
>> Where's the script that generates the alphabetic indexes? Is it in /docbook/scripts ?
>> 
> It's on my computer, had no time to make it ready for pushing it out, i'll try to find some time for it. It is used to generate indexes (in dokuwiki format) published at:
> 
> http://www.kamailio.org/wiki/#alphabetic_indexes
> 
> IIRC, Henning had a different one for old openser/kamailio style.
> 
> Cheers,
> Daniel
> 
> -- 
> Daniel-Constantin Mierla - http://www.asipto.com
> http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda