Hello,
Quick question...
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?
Cheers,
Charles
Hello,
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'.
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.
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:
rm src/modules/acc/README
git checkout src/modules/acc/README
Probably can be done in a single step with the last git command or some alternative.
Cheers, Daniel
On 26.04.17 10:09, Charles Chance wrote:
Thanks!
Charles
On 26 April 2017 at 12:12, Daniel-Constantin Mierla miconda@gmail.com wrote:
-
Charles Chance -
Daniel-Constantin Mierla