Menu
▾
▴
[opengtoolkit-cvs] deab/developer docs DEAB File Dscr.htm,1.6,1.7 DEAB Glossary.htm,1.5,1.6 news.txt,1.16,1.17
|
From: Konstantin S. <ks...@us...> - 2004-11-05 12:14:47
|
Update of /cvsroot/opengtoolkit/deab/developer docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv2751/developer docs Modified Files: DEAB File Dscr.htm DEAB Glossary.htm news.txt Log Message: Index: news.txt =================================================================== RCS file: /cvsroot/opengtoolkit/deab/developer docs/news.txt,v retrieving revision 1.16 retrieving revision 1.17 diff -C2 -d -r1.16 -r1.17 *** news.txt 3 Nov 2004 12:46:44 -0000 1.16 --- news.txt 5 Nov 2004 12:13:59 -0000 1.17 *************** *** 4,7 **** --- 4,28 ---- + *** 19:06 05.11.2004 + + - General Section: Revision File key. + + - General Section: Version VI Name key. + + - General Section: Version Ctrl key. + + - DEAB Glossary.htm + Definitions are added for "Revision File" and "Build File". + + - DEAB File Dscr.htm + a) Descripton are added for "Revision File", "Version VI Name" and "Version Ctrl Name" + b) Description of "New Build Root" is changed; please read it carefully. + + - <deab\DEAB_Builder.llb\DEAB Builder.vi> uses "build_deab_revisions.txt" file to save + version/build information in a target DEAB build. I.e. the "DEAB Current Version__deab.vi" + will return a version, build number and build date/time of when it was built. + + + *** 19:35 03.11.2004 *************** *** 18,21 **** --- 39,43 ---- + *** 19:24 02.11.2004 Index: DEAB Glossary.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/developer docs/DEAB Glossary.htm,v retrieving revision 1.5 retrieving revision 1.6 diff -C2 -d -r1.5 -r1.6 *** DEAB Glossary.htm 5 Nov 2004 04:24:13 -0000 1.5 --- DEAB Glossary.htm 5 Nov 2004 12:13:59 -0000 1.6 *************** *** 4,8 **** <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>Untitled Document</title> </head> --- 4,8 ---- <head> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> ! <title>DEAB Glossary</title> </head> *************** *** 12,15 **** --- 12,16 ---- <ul> <li><a href="#Ambiguous_VI">Ambiguous VI</a></li> + <li><a href="#Build_File">Build File</a></li> <li><a href="#Build_Root">Build Root</a></li> <li><a href="#EXE">EXE</a></li> *************** *** 24,27 **** --- 25,29 ---- <li><a href="#Project_Root">Project Root</a></li> <li><a href="#Resource">Resource File</a></li> + <li><a href="#Revision_File">Revision File</a></li> <li><a href="#Shared_Library">Shared Library</a></li> <li><a href="#Source_Root">Source Root</a></li> *************** *** 31,34 **** --- 33,38 ---- <p><a name="Ambiguous_VI"></a><b>Ambiguous VI</b> - a VI which has at least one caller that expected it to have been loaded from different location on disk. This can be caused by having two instances of the Ambiguous VI on disk, but usually is caused by an application hierarchy that was reorganized (folder structures changed) on disk and was not re-saved.</p> + <p><a name="Build_File"></a><b>Build File</b> - A file containing instructions + and definitions how to build a target application.</p> <p><a name="Build_Root" id="Build_Root"></a><b>Build Root</b> - The (configurable) path where the built software product is to be created all destination locations are specified relative to the build root.</p> <p><a name="EXE" id="EXE"></a><b>EXE</b> - An executable program. On windows this usually has an *.exe file extension. On Linux, executables will probably not have any file extension. On Macintosh, they will probably have a *.app extension.</p> *************** *** 64,70 **** --- 68,94 ---- non-VI files to which a VI can be linked. Typically, resource file is <a href="#Help_File">Help File</a>, Run-Time menu, <a href="#Shared_Library">Shared Library</a>, etc. </p> + <p><a name="Revision_File"></a><b>Revision File</b> - A text file storing + version information and status of the last build.<br> + The version information includes a version string, the last build number and + date/time of the last build. When a build starts, DEAB saves date/time of that + and increments a build number in a Revision File (if any specified in the <a href="#Build_File">Build + File</a>). A version string is user defined and it is beyond of the DEAB + control. However, DEAB can use its value to assign a version information to a + specified control of a VI in a built application as a default value, so the + application can obtain the version (as well as a build number and build + date/time) at runtime.<br> + The build status information includes fatal and non-fatal errors status, and a + name of <a href="#Log_File">Log File</a> written.<br> + A single revision file can be used to serve several build files independently. </p> <p><a name="Shared_Library" id="Shared_Library"></a><b>Shared Library</b> - <font size="-1">A file that contains routines that can be dynamically loaded and shared by applications. In LabVIEW, shared libraries are called using the Call Library Function primitive.</font> In Windows shared libary files are called Dynamic Linked Libraries and have a *.dll file extension. In Linux, shared libraries have a *.so file extension. In Mac OS 9 shared libraries have a .shlb file extension and in Mac OS X, they have a *.framework file extension. </p> <p><a name="Source_Root" id="Source_Root"></a><b>Source Root</b> -The (configurable) path where the software product source files are kept. Source file paths are specified relative to the Source Root. </p> <p><a name="Support_File" id="Support_File"></a><b>Support File</b> -A support file is a file which is part of the built software product, but is not a VI, CTL, or other file that LabVIEW has knowledge of. Since this file can not be located using LabVIEW it must be explicitly specified as a Support File. </p> + <p> </p> + <p> </p> + <p> </p> + <p> </p> + <p> </p> + <p> </p> + <p> </p> </body> </html> Index: DEAB File Dscr.htm =================================================================== RCS file: /cvsroot/opengtoolkit/deab/developer docs/DEAB File Dscr.htm,v retrieving revision 1.6 retrieving revision 1.7 diff -C2 -d -r1.6 -r1.7 *** DEAB File Dscr.htm 5 Nov 2004 07:31:06 -0000 1.6 --- DEAB File Dscr.htm 5 Nov 2004 12:13:59 -0000 1.7 *************** *** 18,21 **** --- 18,23 ---- <p><b>[General]</b><br> <a href="#General: File Format Version">File Format Version</a><br> + <a href="#General: Revision File"> + Revision File</a><br> <a href="#General: Project Root">Project Root</a><br> <a href="#General: Build Root">Build Root</a><br> *************** *** 39,42 **** --- 41,50 ---- <a href="#General: Rsrc Dirs">External Subr Dir</a><br> <a href="#General: EXE Icon">EXE Icon File</a><br> + <a href="#General: Version VI/Ctrl Name"> + Version VI Name</a><br> + <a href="#General: Version VI/Ctrl Name"> + Version Ctrl Name</a></p> + + <p> <br> <a href="#Top-Level VIs"><b>[Top Level VIs]</b></a><br> *************** *** 69,73 **** version 0.0.0. If <i>File Format Version</i> is greater than the current DEAB version, a warning will be generated.</p> ! <p><u>Examples:</u></p> <p>File Format Version = 1.0.0<br> </p> --- 77,81 ---- version 0.0.0. If <i>File Format Version</i> is greater than the current DEAB version, a warning will be generated.</p> ! <p><u>Example:</u></p> <p>File Format Version = 1.0.0<br> </p> *************** *** 75,78 **** --- 83,103 ---- <hr> + <p><b><a name="General: Revision File"></a>[General]</b></p> + <p><b>Revision File</b> = "file path"</p> + <p><i>Revision File</i> is optional parameter that specifies a Revision File to + be used. For more information on a Revision File, see <a href="DEAB%20Glossary.htm" target="_blank"> DEAB + Glossary</a>. A <i>Revision + File</i> may be either an absolute path, or a path relative to the + <i><a href="#General: Project Root"> Project Root</a></i>. If a specified <i>Revision + File</i> does not exist, it will be created and default values will be assigned + to its parameters. It is possible to specify the same <i>Revision File</i> in + different build files. Information relating to each build file is stored in + unique section that has name of the build file.</p> + <p><u>Example:</u></p> + <p>Revision File = "build_support/MyProjectRevisions.txt"<br> + </p> + + + <hr> <p><b><a name="General: Project Root"></a>[General]</b></p> <p><b>Project Root</b> = "dir path"</p> *************** *** 143,146 **** --- 168,179 ---- <p><b><a name="General: New Build Root"></a>[General]</b></p> <p><b>New Build Root</b> = True/False</p> + <p>[KS] the correct edition of this is: + </p> + <p>If <i> New Build Root</i> key is equal to TRUE and <i><a href="#General: Build Root">Build Root</a></i> + directory exists when the build begins, the existing directory will be renamed with a date-time suffix and new + <i>Build Root</i> directory will be created for the active build. By default, the parameter is FALSE. + </p> + <p>[KS] i.e. exactly Build Root is renamed + </p> <p>If <i> New Build Root</i> key is equal to TRUE and a directory at<i><a href="#General: Build Root"> Build Root</a></i> exists when the build begins, the existing directory will be renamed with a date-time suffix and new directory at <i> Build Root</i> will be created for the active build. By default, the parameter is FALSE.<br> *************** *** 165,169 **** <hr> <p><b><a name="General: Log File"></a>[General]</b></p> ! <p><b>Log File</b> = "file path"</p> <p><i>Log File</i> is an optional parameter that specifies a log file. If it is not specified, it is assumed to be a file with name of the .deab file and '.log' extension, located in <i><a href="#General: Log Dir">Log Dir</a></i> directory. <i> Log File</i> may be either an absolute path or a path relative to --- 198,202 ---- <hr> <p><b><a name="General: Log File"></a>[General]</b></p> ! <p><b>Log File</b> = "file path/name"</p> <p><i>Log File</i> is an optional parameter that specifies a log file. If it is not specified, it is assumed to be a file with name of the .deab file and '.log' extension, located in <i><a href="#General: Log Dir">Log Dir</a></i> directory. <i> Log File</i> may be either an absolute path or a path relative to *************** *** 216,219 **** --- 249,277 ---- </p> <hr> + <p><b><a name="General: Version VI/Ctrl Name"></a>[General]</b></p> + <p><b>Version VI Name</b> = "string"<b><br> + Version Ctrl Name</b> = "string"</p> + <p>Both these parameters are optional, they specify a control on FP of a VI that + is to accept version information of the current build as a default value. <i>Version + Ctrl Name</i> specifies a control name, and <i>Version VI Name</i> specifies a + name of the VI that contains the control. The VI must be in the current build + hierarchy (i.e. in hierarchy of a VI specified in either <i><a href="#Top-Level VIs">[Top + Level VIs]</a></i> or <i><a href="#Dynamic VIs">[Dynamic VIs]</a></i> section. + The control must have a type either the same as or compatible with <b><font size="1">Version Info + Cluster_deab_api.ctl</font></b> type definition (it can be found on DEAB's Controls + Palette).</p> + <p>DEAB takes the version information from a <a href="#General: Revision File"><i>Revision + File</i></a> and assigns it to the specified control as default value. This way, + a built application can obtain version information such as a version string, a + build number and build date/time at runtime.</p> + <p>If either of these parameters is empty string (or missed), the DEAB does not + save version information. If either of names is wrong, DEAB generates a + non-fatal error and save the information on it to a <i><a href="#General: Log File">Log + File</a></i>.</p> + <p><u>Example:</u></p> + <p>Version VI Name = "My Project Version.vi"<br> + Version Ctrl Name = "Version Info"<br> + </p> + <hr> <p><b><a name="Top-Level VIs"></a>[Top Level VIs]</b></p> <p><b>keyname</b> = "VI path"</p> *************** *** 369,375 **** <p># This will copy *.ini files from source directories, where VIs saved to beneath "App\PlugIns" reside, to the respective sub-directories of "App\PlugIns" <br> - <br> </p> </body> --- 427,437 ---- <p># This will copy *.ini files from source directories, where VIs saved to beneath "App\PlugIns" reside, to the respective sub-directories of "App\PlugIns" <br> </p> + <hr> + <p> </p> + <p> </p> + <p> </p> + </body> |
