Docs => Development Branch. It's about that time!
by Charlie Patterson · in Torque 2D Professional · 06/08/2013 (12:01 pm) · 3 replies
Hi Torquers.
As mentioned in this thread a while ago, it's about time to pull over a pretty big change to the dev branch and get the docs upgraded!
Speak now or forever hold your peace. :P
Here is the change list.
I have made a strong effort to create no bugs and to find the ones I did make while creating so many files. The work was done very programatically so there was less chance for human error. I also tested with the sandbox constantly. However, let me be up front that there was no way I could create thorough scenarios for over 2000 functions that got moved!
So please work/test with the new development branch (when it is merged) and help by posting any errors you find. I can fix 'em pretty quickly. The most likely is a "missing functions" error due to so many things being moved to new files and then reconnected.
And here are some notes on my mind:
* How the new doc system works is documented here.
* The changes are relatively superficial but extensive -- 238 changed files! If there was a console method or function, and it wasn't in a scriptBinding.h file, it is now. This means there are a lot of new binding files, and a lot of engine files that are now smaller.
* If a console function is documented with the old style, it will still work. This is by design.
* The exception to moving all console methods and functions was the GUI ones. That was just another 10 hours of re-arranging that I (or someone) hasn't done. And it will be harder to test. And there is very little documentation on those yet anyway.
As mentioned in this thread a while ago, it's about time to pull over a pretty big change to the dev branch and get the docs upgraded!
Speak now or forever hold your peace. :P
Here is the change list.
I have made a strong effort to create no bugs and to find the ones I did make while creating so many files. The work was done very programatically so there was less chance for human error. I also tested with the sandbox constantly. However, let me be up front that there was no way I could create thorough scenarios for over 2000 functions that got moved!
So please work/test with the new development branch (when it is merged) and help by posting any errors you find. I can fix 'em pretty quickly. The most likely is a "missing functions" error due to so many things being moved to new files and then reconnected.
And here are some notes on my mind:
* How the new doc system works is documented here.
* The changes are relatively superficial but extensive -- 238 changed files! If there was a console method or function, and it wasn't in a scriptBinding.h file, it is now. This means there are a lot of new binding files, and a lot of engine files that are now smaller.
* If a console function is documented with the old style, it will still work. This is by design.
* The exception to moving all console methods and functions was the GUI ones. That was just another 10 hours of re-arranging that I (or someone) hasn't done. And it will be harder to test. And there is very little documentation on those yet anyway.
#2
06/09/2013 (9:59 am)
@Mike, yeah, if Git is worth its salt (and it will be), then it will recognize this as a conflict and force me to handle it manually! This will happen a few times, I suspect.
#3
I'll refer back to this post on merge and see this!
Good catch, because I'm not sure any process would have caught this.
06/09/2013 (10:04 am)
Oh, wait, I get it. Yeah, what will probably happen is they will merge just fine because they are new. I won't get a conflict warning. But the doc system used will be old, as it should be. This won't hurt but it also won't show up in the new docs. That's a bummer but we can get it fixed in 1 minute.I'll refer back to this post on merge and see this!
Good catch, because I'm not sure any process would have caught this.
Associate Mike Lilligreen
Retired T2Der