Cs Set Ver Info Manual
This information applies to CsSetVerInfo version 1.27.86.9
Contents:
- Overview
- Using the CsSetVerInfo tool
- Adding version information to a new project.
- Configuring Visual Studio 2008 to CsSetVerInfo
Other links:
- Consys home page
- CsVerDoc - Tool for generating Web page based on information created by CsSetVerInfo
- Revision control - information about setting up and using revision control for ConSys.
Overview:
CsSetVerInfo is used to view and maintain project version information for ConSys projects. The version information is stored in XML files in the project folder. The tool also generates a project version file to be included in the project code when generating the version number.
The XML files produced by this tool can be used to generate html based version documentation by the CsVerDoc tool.
Using
the CsSetVerInfo tool:
With Visual Studio 2008 configured as described below, Pressing the 'Version Info' toolbar button will bring up the CsSetVerInfo for the project containing the file in the current active window in Visual Studio 2008.
First, Prev, Next, Last: Navigate through version loggings.
Set to Version +1: Set to first 3 numbers in version string based on current code version: The first two numbers is current major and minor version, 3rd number is set to current SVN version + 1 (best guess for next SVN version number when committed). Can only be for the 'Last' page (the version currently under development).
New (Increment) Version: Increase project version number by one, clean all data fields, set Revision date to current date and Developer to user name of the user currently logged in.
Notes: Notes for the version. Remark: Will be copied as entered to the html documentation when the web page is build with the CsDocVer tool. This implies that CR (carriage return) and NL (new linie) as well as additional white spaces will not appear on the generated web page. Use html mark-up code (like <pre></pre> and <br>) in the note, if you want any formatting of the note in the generated page.
New Features: List of features implemented in this version
Corrected bugs: List of bugs corrected in this version
The New and Edit buttons in new feature list and corrected bug list will open the form:
ELog Message ID: Message ID of the ELog entry corresponding to the feature or corrected bug. Show will open the ELog with the message ID. When generating the web page with CsVerDoc, a link to the ELog entry will be created next to the feature/Corrected bug.
Highlight: Make the feature/Corrected bug text bold when generating the web page.
Show in Common Version: If selected, the feature/corrected bug will be shown in the Common changes web page (web page for major changes between ConSys versions). Remark: Support for this feature is not implemented yet in CsVerDoc (20081002)).
Adding
version information to a new project.:
- Open or activate any file in the project.
- Start the CsSetVerInfo tool (see Configuring Visual Studio 2008 below)
- Configure the generated page configuration (press
Generated Page Configuration)
- Set the Generated web page settings (Filename and path for web page to be generated by the CsVerDoc tool)
- Optionally, define links that should be included in the generated web page. The links must be relative to the web page path specified for the generated page or absolute.
- Press Ok
- => 'ProjVersionCfg.xml' is created in the project directory
- Back in the Project Information Form, Press
Save or Save & Close
- 'ProjVersion.xml' and '<projectname>Version.h' is created in the project directory.
- From Visual Studio 2008, solution explorer - Add
files above to the project:
- Right click 'Header Files' - Add Existing Items.., Find and add '<projectbame>Version.h'
- Right click '<Project>' - Add Existing Items.., Find and add the two xml files: 'ProjVersion.xml' and 'ProjVersionCfg.xml
- Add ' 'ProjVersion.xml' and 'ProjVersionCfg.xml' and '<projectname>Version.h' to TortoiseSVN (HINT: Can be done in the step above from the Dev. Studio solution explorer when adding the files)
- It is now a good time to commit the changes to SVN ...
- Include version information in the code: See Revision control, Adding version information to the project resource file.
Configuring
Visual Studio 2008 to CsSetVerInfo:
The Visual Studio 2008/2015 must be configured to use the CsSetVerInfo tool:
From the 'Tools' menu, select 'External Tools ...'
Add 'CsSetVerInfo.exe' from the work directory, ..\SvnScripts', and set the options as shown below:
Commmand arguments:
0: Project path including last \
1: Project filenam
2: ConSys project root path including last \ - optional, only needed in ConSys root is path is not like ..\..\ConSys\)
The tool will now be available from tools menu in Visual Studio 2008/2015. It is convenient to have the tool as a button in the toolbar.
Add tool to control bar:
-
Right click toolbar, choose 'Customize ...'
-
Select 'Commands' tab
-
Select 'Tools' in the Categories list
-
Drag 'External Command X' to the toolbar where you want the Version Information tool (X is the external tool index from the External Tools dialog above - If 'Version Info' is moved to the top of the list as in the example, select 'External Command 1'
-
Right click on the dropped tool and set tool name and Icon.
Last Modified 06 May 2020