<html>
  <head>

    <meta http-equiv="content-type" content="text/html; charset=utf-8">
  </head>
  <body bgcolor="#FFFFFF" text="#000000">
    <p>Hello,</p>
    <p>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.</p>
    <p>The cron job is running every 15min.</p>
    <p>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.</p>
    <p>The commits in this case are done by a generic git account named
      kamailio-dev.</p>
    <p>The commit message looks like:</p>
    <pre wrap="">modules: readme files regenerated - app_mono ...</pre>
    Only the first module that has the readme updated is listed (in this
    example being app_mono).<br>
    <br>
    The readmes are automatically generated for master and 4.4 branches.<br>
    <br>
    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:<br>
    <br>
      make modules-readme modules=modules/async<br>
    <br>
      rm modules/async/README<br>
      git checkout modules/async/README<br>
    <br>
    Cheers,<br>
    Daniel<br>
    <br>
    <pre class="moz-signature" cols="72">-- 
Daniel-Constantin Mierla
<a class="moz-txt-link-freetext" href="http://www.asipto.com">http://www.asipto.com</a> - <a class="moz-txt-link-freetext" href="http://www.kamailio.org">http://www.kamailio.org</a>
<a class="moz-txt-link-freetext" href="http://twitter.com/#!/miconda">http://twitter.com/#!/miconda</a> - <a class="moz-txt-link-freetext" href="http://www.linkedin.com/in/miconda">http://www.linkedin.com/in/miconda</a></pre>
  </body>
</html>