Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
Thanks, /O
On 05/31/2016 04:54 PM, Olle E. Johansson wrote:
Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
@miconda and I already discussed a way to automate the README generation on every commit but I still don't like to have generated files on the repo, it feels wrong to me
The idea is to regenerate all of them and make a commit for the updates.
I'll try to investigate on my free cycles
Hello,
to save some effort -- the generated readme files can be pushed all at once if they are too many.
The plan is to generate them on kamailio.org and push them based on cron.d, so the devs will only change the xml files. I discussed a bit with Victor Seva at kamailio.org to do this, but we haven't gotten there yet.
Cheers, Daniel
On 31/05/16 16:54, Olle E. Johansson wrote:
Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
Thanks, /O _______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
On 31 May 2016, at 17:14, Daniel-Constantin Mierla miconda@gmail.com wrote:
Hello,
to save some effort -- the generated readme files can be pushed all at once if they are too many.'
Thanks, it was a bit painful...
The plan is to generate them on kamailio.org and push them based on cron.d, so the devs will only change the xml files. I discussed a bit with Victor Seva at kamailio.org to do this, but we haven't gotten there yet.
That may be clever. There was way too many differences.
/O
Cheers, Daniel
On 31/05/16 16:54, Olle E. Johansson wrote:
Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
Thanks, /O _______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org mailto:sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
-- Daniel-Constantin Mierla http://www.asipto.com http://www.asipto.com/ - http://www.kamailio.org http://www.kamailio.org/ http://twitter.com/#!/miconda http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda http://www.linkedin.com/in/miconda_______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
On 31/05/16 17:16, Olle E. Johansson wrote:
[...]
The plan is to generate them on kamailio.org http://kamailio.org and push them based on cron.d, so the devs will only change the xml files. I discussed a bit with Victor Seva at kamailio.org http://kamailio.org to do this, but we haven't gotten there yet.
That may be clever. There was way too many differences.
A lot of diffs are because various OSes use different whitespacing for xml stylesheets and special chars. This is what we try to avoid, by generating them in a single place.
Cheers, Daniel
/O
Cheers, Daniel
On 31/05/16 16:54, Olle E. Johansson wrote:
Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
Thanks, /O _______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
-- Daniel-Constantin Mierla http://www.asipto.com - http://www.kamailio.org http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda _______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org mailto:sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
On 31 May 2016, at 17:18, Daniel-Constantin Mierla miconda@gmail.com wrote:
On 31/05/16 17:16, Olle E. Johansson wrote:
[...]
The plan is to generate them on kamailio.org http://kamailio.org/ and push them based on cron.d, so the devs will only change the xml files. I discussed a bit with Victor Seva at kamailio.org http://kamailio.org/ to do this, but we haven't gotten there yet.
That may be clever. There was way too many differences.
A lot of diffs are because various OSes use different whitespacing for xml stylesheets and special chars. This is what we try to avoid, by generating them in a single place.
I know. I went through all files and only committed when there was real changes, not that stuff. And there where a lot of sections missing and other editorial changes, not just the URL to the bug tracker.
I wonder if that depends on default settings or version of docbook tools. It is very strange. Maybe a more detailed style sheet would remove a lot of those. Just guessing :-)
/O
Cheers, Daniel
/O
Cheers, Daniel
On 31/05/16 16:54, Olle E. Johansson wrote:
Hi!
I noticed that the link to the bug tracker was wrong in our Docbook XML entities and re-generated all READMEs.
To my surprise, a lot of them contains new parameters, new text and new functions - stuff that was committed to the XML files, but not to the text file README. I noticed while going through all the diff’s.
Prepare for a long series of commits. And when you update the XML docs, please update the README.
In worst case, I may have to do this twice, so that our 4.4 docs are also current with the code and the XML files.
Thanks, /O _______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org mailto:sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
-- Daniel-Constantin Mierla http://www.asipto.com http://www.asipto.com/ - http://www.kamailio.org http://www.kamailio.org/ http://twitter.com/#!/miconda http://twitter.com/#%21/miconda - http://www.linkedin.com/in/miconda http://www.linkedin.com/in/miconda_______________________________________________ sr-dev mailing list sr-dev@lists.sip-router.org mailto:sr-dev@lists.sip-router.org http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
-- Daniel-Constantin Mierla http://www.asipto.com http://www.asipto.com/ - http://www.kamailio.org http://www.kamailio.org/ http://twitter.com/#!/miconda http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda http://www.linkedin.com/in/miconda
On Tuesday 31 May 2016, Daniel-Constantin Mierla wrote:
A lot of diffs are because various OSes use different whitespacing for xml stylesheets and special chars. This is what we try to avoid, by generating them in a single place.
A tactically placed LC_ALL=C inside the Makefile for the README might solve a lot of those issues. At least doing a "LC_ALL=C make README" creates smaller diffs for me.
On 13 Jun 2016, at 14:26, Alex Hermann alex@speakup.nl wrote:
On Tuesday 31 May 2016, Daniel-Constantin Mierla wrote:
A lot of diffs are because various OSes use different whitespacing for xml stylesheets and special chars. This is what we try to avoid, by generating them in a single place.
A tactically placed LC_ALL=C inside the Makefile for the README might solve a lot of those issues. At least doing a "LC_ALL=C make README" creates smaller diffs for me.
That’s propably good advice. I’ll run some tests.
Thank you for that advice!
/O
-
Alex Hermann -
Daniel-Constantin Mierla -
Olle E. Johansson -
Victor Seva