<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
</head>
<body bgcolor="#FFFFFF" text="#000000">
<p>Hello,</p>
<p>it is no longer needed to generate the readme from xml docs and
push it to git. There is a script running on kamailio.org checking
every 15 min (iirc) for changes, generates the readmes and pushes
them to git. They appear as a commit from 'Kamailio Dev'.</p>
<p>The main reason was that xml docbook settings for whitespacing,
line length and section numbering are different from OS to OS and
a small change in xml file could result in a totally different
look for readme if the readme was not generated on the same system
like previous version. Backporting is no longer easier in such
case.</p>
<p>Anyhow, it is good to generate readme locally in case you did lot
of changes and there might be syntax errors. Once you see it is
generated correctly, just delete it locally and check it out
again. Say I generated the readme for acc module to be sure it is
ok, then I just do:</p>
<p>rm src/modules/acc/README</p>
<p>git checkout src/modules/acc/README</p>
Probably can be done in a single step with the last git command or
some alternative.<br>
<br>
Cheers,<br>
Daniel<br>
<br>
<div class="moz-cite-prefix">On 26.04.17 10:09, Charles Chance
wrote:<br>
</div>
<blockquote
cite="mid:CAOvxgzDFNHiiALA144sSmo6FtfLFc0jXSBMdGTM3owTVPfDGiA@mail.gmail.com"
type="cite">
<div dir="auto">Hello,
<div dir="auto"><br>
</div>
<div dir="auto">Quick question...</div>
<div dir="auto"><br>
</div>
<div dir="auto">I always have done so far out of routine, but
wondered if it was actually necessary to manually rebuild the
readme (and commit) after a change to an xml doc?</div>
<div dir="auto"><br>
</div>
<div dir="auto">Cheers,</div>
<div dir="auto"><br>
<div data-smartmail="gmail_signature" dir="auto">Charles</div>
</div>
</div>
<br>
<div><font
style="font-size:10pt;font-family:Helvetica,Arial,sans-serif"
color="gray">Sipcentric Ltd. Company registered in England
& Wales no. 7365592.</font><span
style="font-size:10pt;font-family:Helvetica,Arial,sans-serif"> </span><font
style="font-size:10pt;font-family:Helvetica,Arial,sans-serif"
color="gray">Registered office: Faraday Wharf, Innovation
Birmingham Campus, Holt Street, Birmingham Science Park,
Birmingham B7 4BB.</font></div>
<br>
<fieldset class="mimeAttachmentHeader"></fieldset>
<br>
<pre wrap="">_______________________________________________
Kamailio (SER) - Development Mailing List
<a class="moz-txt-link-abbreviated" href="mailto:sr-dev@lists.kamailio.org">sr-dev@lists.kamailio.org</a>
<a class="moz-txt-link-freetext" href="https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev">https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev</a>
</pre>
</blockquote>
<br>
<pre class="moz-signature" cols="72">--
Daniel-Constantin Mierla
<a class="moz-txt-link-abbreviated" href="http://www.twitter.com/miconda">www.twitter.com/miconda</a> -- <a class="moz-txt-link-abbreviated" href="http://www.linkedin.com/in/miconda">www.linkedin.com/in/miconda</a>
Kamailio Advanced Training - May 22-24 (USA) - <a class="moz-txt-link-abbreviated" href="http://www.asipto.com">www.asipto.com</a>
Kamailio World Conference - May 8-10, 2017 - <a class="moz-txt-link-abbreviated" href="http://www.kamailioworld.com">www.kamailioworld.com</a></pre>
</body>
</html>