[sr-dev] A: README files for modules generated automatically

[Daniel-Constantin Mierla]

Hello,

following past discussions about different formats resulted when
generating readme files for modules on various systems, which typically
led to conflicts when backporting, I put in place a cron job running on
kamailio.org to fetch from github the docbook files, generate the readme
and push them back.

The cron job is running every 15min.

>From now on it is no longer needed to generate the readme yourself. Just
commit the changes to xml files and push them to git repository. The
readme will be refreshed automatically in a bit.

The commits in this case are done by a generic git account named
kamailio-dev.

The commit message looks like:

modules: readme files regenerated - app_mono ...

Only the first module that has the readme updated is listed (in this
example being app_mono).

The readmes are automatically generated for master and 4.4 branches.

If you do consistent changes to the docbook file, you can generate the
readme locally to be sure there is no error, then restore the old
version before committing - relevant commands:

  make modules-readme modules=modules/async

  rm modules/async/README
  git checkout modules/async/README

Cheers,
Daniel

-- 
Daniel-Constantin Mierla
http://www.asipto.com - http://www.kamailio.org
http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sip-router.org/pipermail/sr-dev/attachments/20160608/bd2c1267/attachment.html>