The BlackBox Build Engine - Revision history

Josef templ: bbscript.exe replacement startegy added

2015-05-13T11:36:47Z

bbscript.exe replacement startegy added

← Older revision		Revision as of 11:36, 13 May 2015
Line 50:		Line 50:

	For rebuilding the scripting engine incrementally, i.e. BlackBox has been built before in the same directory, the script appbuild/newbbscript.txt must be executed. It compiles the new and adapted modules and links an exe file named newbbscript.exe. The involved subsystem 'Script' and bbscript.exe are not part of the generated BlackBox distribution.		For rebuilding the scripting engine incrementally, i.e. BlackBox has been built before in the same directory, the script appbuild/newbbscript.txt must be executed. It compiles the new and adapted modules and links an exe file named newbbscript.exe. The involved subsystem 'Script' and bbscript.exe are not part of the generated BlackBox distribution.

			In case of successfully building for 'master', the newly generated bbscript.exe will replace the previous one and will be used for all subsequent builds of any branch.

	There are no principal limitations for the executed scripts except that they must not		There are no principal limitations for the executed scripts except that they must not

Josef templ: /* An alternative scripting mechanism */

2014-09-16T15:02:05Z

An alternative scripting mechanism

← Older revision		Revision as of 15:02, 16 September 2014
Line 65:		Line 65:

	== An alternative scripting mechanism ==		== An alternative scripting mechanism ==
	For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp' in revision 5675e23b. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.		For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp' in [http://redmine.blackboxframework.org/projects/blackbox/repository/revisions/5675e23bc36866fe1fb34a8ad1bc334df48f8fc5 revision 5675e23b]. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.

	The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.		The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.

	This scripting tool is kept in the repository together with bbscript in order to serve as a backup in case there are any severe problems with bbscript.		This scripting tool is kept in the repository together with bbscript in order to serve as a backup in case there are any severe problems with bbscript.

Josef templ: /* An alternative scripting mechanism */

2014-09-16T14:57:34Z

An alternative scripting mechanism

← Older revision		Revision as of 14:57, 16 September 2014
Line 65:		Line 65:

	== An alternative scripting mechanism ==		== An alternative scripting mechanism ==
	For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.		For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp' in revision 5675e23b. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.

	The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.		The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.

	This scripting tool is kept in the repository together with bbscript in order to serve as a backup in case there are any severe problems with bbscript.		This scripting tool is kept in the repository together with bbscript in order to serve as a backup in case there are any severe problems with bbscript.

Josef templ at 06:58, 10 September 2014

2014-09-10T06:58:54Z

Josef templ at 15:37, 2 September 2014

2014-09-02T15:37:26Z

← Older revision		Revision as of 15:37, 2 September 2014
Line 28:		Line 28:
	== Internals of the build engine ==		== Internals of the build engine ==
	The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)		The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)
	built on top of BlackBox in order to compile BlackBox modules ~~and~~ and link the BlackBox.exe file		built on top of BlackBox in order to compile BlackBox modules and link the BlackBox.exe file
	with BlackBox itself.		with BlackBox itself.

Josef templ: /* An alternative scripting mechanism */

2014-08-21T07:38:19Z

An alternative scripting mechanism

← Older revision		Revision as of 07:38, 21 August 2014
Line 68:		Line 68:

	The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.		The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.

			This scripting tool is kept in the repository together with bbscript in order to serve as a backup in case there are any severe problems with bbscript.

Josef templ at 12:36, 20 August 2014

2014-08-20T12:36:55Z

← Older revision		Revision as of 12:36, 20 August 2014
Line 22:		Line 22:
	* a build log file in html format named '''blackbox-XXX-buildlog.html'''		* a build log file in html format named '''blackbox-XXX-buildlog.html'''

	In case of an unsuccessful build, only the ~~build~~ log file will be produced.		In case of an unsuccessful build, only the log file will be produced.
			If a build is aborted and no version information is available, the log file '''logFile.html''' is created in
	~~----~~		[http://blackboxframework.org/dev/ http://blackboxframework.org/dev].

	'''~~Internals of the build engine~~'''

			== Internals of the build engine ==
	The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)		The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)
	built on top of BlackBox in order to compile BlackBox modules and and link the BlackBox.exe file		built on top of BlackBox in order to compile BlackBox modules and and link the BlackBox.exe file
Line 65:		Line 64:
	Note: For the future, it should be regarded as the ultimate goal to get rid of all the adapted standard modules in order to avoid maintenance problems. Also the scripting engine itself, i.e. the functionality provided by the Config file could be made available as a standard module such as DevScript because it is of general use for example for installing additional subsystems that are distributed in source form and that need a sequence of commands to be executed for proper installation.		Note: For the future, it should be regarded as the ultimate goal to get rid of all the adapted standard modules in order to avoid maintenance problems. Also the scripting engine itself, i.e. the functionality provided by the Config file could be made available as a standard module such as DevScript because it is of general use for example for installing additional subsystems that are distributed in source form and that need a sequence of commands to be executed for proper installation.

	~~----~~		== An alternative scripting mechanism ==
	~~'''~~An alternative scripting mechanism~~'''~~

	For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.		For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.

	The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.		The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.

Josef templ at 10:20, 20 August 2014

2014-08-20T10:20:44Z

← Older revision		Revision as of 10:20, 20 August 2014
Line 29:		Line 29:

	The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)		The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)
	built on top of BlackBox in order to compile ~~and Link~~ BlackBox modules and the BlackBox.exe file		built on top of BlackBox in order to compile BlackBox modules and and link the BlackBox.exe file
	with BlackBox itself.		with BlackBox itself.

Line 35:		Line 35:
	It essentially consists of a special 'Config' file that interprets the		It essentially consists of a special 'Config' file that interprets the
	/PAR command line option as the file name of a BlackBox script. In order to successfully execute		/PAR command line option as the file name of a BlackBox script. In order to successfully execute
	bbscript, the BlackBox resource files must be available either from the startup directory ~~of bbscript.exe~~ or		bbscript.exe, the BlackBox resource files must be available either from the startup directory or
	via the /USE command line option. Executing bbscript.exe under Linux requires(1) wine, the Windows API emulator available under Linux and (2) it		via the /USE command line option. Executing bbscript.exe under Linux requires (1) wine,
	needs Xvfb, the X-Windows virtual frame buffer that allows one to run graphical applications without any physical display device.		the Windows API emulator available under Linux, and (2) for headless operation it
			needs Xvfb, the X-Windows virtual frame buffer that allows one to run graphical
			applications without any physical display device.

	Two forms of scripts exist:		Two forms of scripts exist:

Josef templ at 13:52, 18 August 2014

2014-08-18T13:52:21Z

← Older revision		Revision as of 13:52, 18 August 2014
Line 60:		Line 60:
	an adapted module DevCPM (see ScriptDevCPM) is used. It simply writes the first error to the StdLog output and then generates a TRAP.		an adapted module DevCPM (see ScriptDevCPM) is used. It simply writes the first error to the StdLog output and then generates a TRAP.
	The TRAP is recognized in the build process and stops it.		The TRAP is recognized in the build process and stops it.

			Note: For the future, it should be regarded as the ultimate goal to get rid of all the adapted standard modules in order to avoid maintenance problems. Also the scripting engine itself, i.e. the functionality provided by the Config file could be made available as a standard module such as DevScript because it is of general use for example for installing additional subsystems that are distributed in source form and that need a sequence of commands to be executed for proper installation.

	----		----
Line 66:		Line 68:
	For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.		For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.

	The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files~~. It also~~ requires adaptations in much more files than bbscript does.		The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files and it requires adaptations in much more files than bbscript does.

Josef templ at 13:42, 18 August 2014

2014-08-18T13:42:04Z

← Older revision		Revision as of 13:42, 18 August 2014
Line 28:		Line 28:
	'''Internals of the build engine'''		'''Internals of the build engine'''

	The build engine is implemented as a Python 2.7 script and uses a scripting ~~mechanism~~		The build engine is implemented as a Python 2.7 script and uses the scripting tool 'bbscript.exe' (''B''lack''B''ox ''Script''ing)
	built on top of BlackBox in order to compile and Link BlackBox modules and the BlackBox.exe file		built on top of BlackBox in order to compile and Link BlackBox modules and the BlackBox.exe file
	with BlackBox itself.		with BlackBox itself.

	The scripting ~~engine~~ can be found under the subsystem 'Script'.		The source code of the scripting tool can be found under the subsystem 'Script'.
	It essentially consists of a special 'Config' file that interprets the		It essentially consists of a special 'Config' file that interprets the
	/PAR command line option as the file name of a BlackBox script.		/PAR command line option as the file name of a BlackBox script. In order to successfully execute
			bbscript, the BlackBox resource files must be available either from the startup directory of bbscript.exe or
			via the /USE command line option. Executing bbscript.exe under Linux requires(1) wine, the Windows API emulator available under Linux and (2) it
			needs Xvfb, the X-Windows virtual frame buffer that allows one to run graphical applications without any physical display device.

	Two forms of scripts exist:		Two forms of scripts exist:
Line 44:		Line 47:
	For rebuilding BlackBox itself the script Dev/Docu/Build-Tool.odc is executed.		For rebuilding BlackBox itself the script Dev/Docu/Build-Tool.odc is executed.
	Therefore, when adding new modules to the BlackBox distribution, this script must be adapted by inserting or appending the new module at the right position according to the compile order. It is the only place where a new module must be listed.		Therefore, when adding new modules to the BlackBox distribution, this script must be adapted by inserting or appending the new module at the right position according to the compile order. It is the only place where a new module must be listed.

			For rebuilding the scripting engine incrementally, i.e. BlackBox has been built before in the same directory, the script appbuild/newbbscript.txt must be executed. It compiles the new and adapted modules and links an exe file named newbbscript.exe. The involved subsystem 'Script' and bbscript.exe are not part of the generated BlackBox distribution.

	There are no principal limitations for the executed scripts except that they must not		There are no principal limitations for the executed scripts except that they must not
Line 51:		Line 56:
	Sym or Code directory during BlackBox comilation. In order to avoid this problem, a customized		Sym or Code directory during BlackBox comilation. In order to avoid this problem, a customized
	module is used for HostFiles (see ScriptHostFiles).		module is used for HostFiles (see ScriptHostFiles).

			In order to get access to compile time errors produced by DevCompiler.CompileThis, which is used for building BlackBox,
			an adapted module DevCPM (see ScriptDevCPM) is used. It simply writes the first error to the StdLog output and then generates a TRAP.
			The TRAP is recognized in the build process and stops it.

			----
			'''An alternative scripting mechanism'''

			For historical reasons there is another scripting mechanism available in the subsystems 'Cons' and 'Interp'. It is named dev0.exe and can be created by executing the script appbuild/newdev0.txt. The involved subsystems and dev0.exe are not part of the generated BlackBox distribution.

			The main difference to bbscript is that dev0 does not require Xvfb but on the other side it does not allow one to run all BlackBox commands and to process (compile) all BlackBox files without modifications. It also does not allow one to run scripts stored in .odc files. It also requires adaptations in much more files than bbscript does.

← Older revision		Revision as of 06:58, 10 September 2014
Line 5:		Line 5:
	The build engine is invoked periodically and builds for all branches that have new commits and that have the file		The build engine is invoked periodically and builds for all branches that have new commits and that have the file
	appbuild/AppVersion.txt in the repository. A one line summary message is added to		appbuild/AppVersion.txt in the repository. A one line summary message is added to
	[http://blackboxframework.org/~~dev~~/buildlog.html http://blackboxframework.org/~~dev~~/buildlog.html] for every build performed.		[http://blackboxframework.org/unstable/buildlog.html http://blackboxframework.org/unstable/buildlog.html] for every build performed.

	In case of building a final release, the build engine puts the resulting files into		In case of building a final release, the build engine puts the resulting files into
Line 11:		Line 11:

	In case of building an unstable (intermediate) release such as an alpha or a beta version,		In case of building an unstable (intermediate) release such as an alpha or a beta version,
	the build engine puts the resulting files into a subdirectory of [http://blackboxframework.org/~~dev~~/ http://blackboxframework.org/~~dev~~]		the build engine puts the resulting files into a subdirectory of [http://blackboxframework.org/unstable/ http://blackboxframework.org/unstable]
	which is named after the branch the build has been performed for.		which is named after the branch the build has been performed for.

Line 24:		Line 24:
	In case of an unsuccessful build, only the log file will be produced.		In case of an unsuccessful build, only the log file will be produced.
	If a build is aborted and no version information is available, the log file '''logFile.html''' is created in		If a build is aborted and no version information is available, the log file '''logFile.html''' is created in
	[http://blackboxframework.org/~~dev~~/ http://blackboxframework.org/~~dev~~].		[http://blackboxframework.org/unstable/ http://blackboxframework.org/unstable].

	== Internals of the build engine ==		== Internals of the build engine ==