Revision Analyser v1.0 User Manual
Contents
1. Figure 5 Select Additional Tasks dialog You can also allow the installation to create a desktop icon for you You can do this by checking the Create a desktop icon box in the Select Additional Tasks window Figure 5 Press Next to continue Version 1 0 Page 5 of 14 Revision Analyser User Manual ie Setup Revision Analyser Ready to Install Setup is now ready to begin installing Revision Analyser on your computer Click Install to continue with the installation or dick Back if you want to review or change any settings Destination location C Program Files x86 Revision Analyser setup type Custom Selected components Application Files SolidSX2 Required component for visualization User Manual User manual for Revision Analyser PDF file Recoder Plugin Project type for Java SVN analysis Sourcerer Plugin Project type for the open source project Sourcerer a ICE Cone Figure 6 Ready to Install dialog Finally the Ready to Install dialog will be shown Figure 6 It contains a review of the settings you selected during the installation wizard Press Install to start the installation It can take a few minutes before the installation is finished depending on the options you selected to install Version 1 0 Page 6 of 14 Revision Analyser User Manual 2 Getting started This chapter will guide you through the functionalities of Revision Analyser After following this guide you sh2. you start if Setup Revision Analyser Welcome to the Revision Analyser Setup Wizard This will install Revision Analyser version 1 0 on your computer It is recommended that you dose all other applications before continuing Click Next to continue or Cancel to exit Setup Figure 1 Welcome dialog of the installation The installation starts with the screen shown in Figure 1 Just press Next to continue Version 1 0 Page 3 of 14 Revision Analyser User Manual ie setup Revision Analyser Select Destination Location Where should Revision Analyser be installed L Setup will install Revision Analyser into the following folder To continue dick Next If you would like to select a different folder cick Browse Program Files x86 Revision Analyser Browse Atleast 22 4 MB of free disk space is required Figure 2 Select Destination Location dialog You should now select a destination location in which you want Revision Analyser to be installed Figure 2 You can just leave this to its default and press Next to continue ie Setup Revision Analyser Select Components Which components should be installed Select the components you want to install dear the components you do not want to install Click Next when you are ready to continue SolidSX Required component for visualization User Manual User manual for Revision Analyser PDF file Recoder Plugin Project type for Java SVN a
3. 0 2010 Limit search results Figure 15 Advanced Search dialog After you have searched for SVN revisions you must select the revisions that you want to analyse There are three selection methods available e Select All this will select all SVN revisions for analysis e Select this will select a given percentage of SVN revisions see Figure 16 By default this is set to 10 but you can change this yourself e Select None this will remove all selections that you made Select Percentage Select the percentage of items you would like to evenly select from the list of revisions Figure 16 Select Percentage dialog Version 1 0 Page 11 of 14 Revision Analyser User Manual Figure 17 shows an example of how the selection might look like in the end In this screenshot revision 5 is selected to be analysed Revisions 0 and 10 were already analysed before and therefore have gray text and cannot be selected again Press Add to add the revisions you selected to the Manage SVN Revisions dialog Figure 13 Please note that the Add button is only enabled after you have selected at least one revision Press OK in the Manage SVN Revisions dialog to start the analysis Revision Author Date Message E U 4 10 2010 19 00 58 F 1 johan 4 10 2010 19 03 00 le revisie Fl 2 johan 4 10 2010 19 03 42 bin en obj hoeven niet op SVN Fl 3 johan 5 10 2010 12 36 16 Login functies enz Tm 4 johan 5 10 2010 13 04 58 Admin gede
4. 10 2010 14 52 45 Mark 7 10 2010 18 55 43 STARS Figure 17 Deleting SVN revisions Version 1 0 Page 12 of 14 Revision Analyser User Manual 2 2 3 Task log Whenever you add or delete one or multiple revisions you will get to see the Task Log Figure 18 after you press OK in the Manage SVN Revisions dialog In this Task Log you get to see a detailed overview of the progress of the tasks that have to be performed You can only close the Task Log after all tasks have been completed Task Log Task Log This window shows a log of the tasks that have to be processed After the tasks are finished you may export it to a HTML file Working on task 3 7 Event Removed SVN revision 50 Removed SVN revision 80 Checkout Update started Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Sensor View Architecture pdf Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture SensorViewArchitecture synctex gz Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Sensor View Architecture aux Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture tempfile tmp Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Sensor View Architecture tex Add C Users Johan Pocuments Revision Analyser RecoderProject SVN Architect
5. Delete Figure 20 Options dialog 3 2 View loaded plug ins You can view the currently loaded plugins by clicking on Help gt About Revision Analyser In the About screen press the Plug ins button to open the Plug ins dialog Figure 21 In this dialog you can see the loaded plug ins and more information for each of the plug ins Loaded plug ins Name Sourcerer Recoder Description Recoder is a Java framework for source code metaprogramming aimed to deliver a sophisticated infrastructure for many kinds of Java analysis and transformation tools Copyright 2011 Johan van der Geest and Mark Ettema Version 1 0 0 Figure 21 Plug ins dialog Have you ever heard of the Konami code Why not give it a try in the About dialog Version 1 0 Page 14 of 14
6. L username and password of the SVN server You can test these settings right away by clicking on the Test Connection button In the Recoder Project Settings dialog you can also add JAR libraries or paths containing JAR files that are required for a proper analysis Recoder Project Setting Please specify the URL of the SVN server below If needed you can also specify an username and password URL Username Password Show the password I typed Test Connection Figure 11 Recoder Project Settings dialog When the SVN server uses a SSL connection you will get to see the dialog box in Figure 12 after you press Test Connection Here you have to verify the SSL certificate Press Yes to accept it or No to reject it When you reject it you will be unable to use this SVN server for the project SSL certificate error In order to use this SVN server you must accept the certificate and add itas athrusted certificate to the project Do you want to continue Common name etterma nl Issuer ettema online nl Valid from Tue 29 Mar 2011 17 59 03 GMT Valid to Thu 28 Mar 2013 17 59 03 GMT Figure 12 SSL certificate error dialog Version 1 0 Page 9 of 14 Revision Analyser User Manual 2 2 Manage revisions Now that the SVN server is configured we can start to fetch revisions from the revision server Open the Manage SVN Revisions dialog Figure 13 by clicking on the Project gt Manage SVN Revisio
7. Revision Analyser vio User Manual 29 of June 2011 Written by Johan van der Geest Mark Ettema University of Groningen Revision Analyser User Manual Contents 1 PASTA AU OM acaussasssiacsiaeancassecinesisoneanencancausaccanasecabeaine E ETA 3 LE System TE QUIN GIN CALS T 3 12 nstanaton AW alk ERPOUR 1 DT 3 2 Getting startede E E T E EE EE 7 ZA Creatine a MEW Droe e TT 7 22 Manage OVI SIONS nnee 10 22 1 Adding revisions sasson rinn ei aa ETT E E aa nes 10 Dd Deleting GEV ISIONS euna a eine E T 12 223 VAS KNOG acer eta O EE E 13 2 3 Usine the revision UMM wenend a er nele 13 E OtherfunctionalitieSsssrossssce a EAE 14 St APPC SENINE S eean TET 14 Pe WCW OAC dPR IAS aeaa T E EN EON OE 14 Version 1 0 Page 2 of 14 Revision Analyser User Manual 1 Installation Before you install Revision Analyser it is a good idea to first check the system requirements and installation walkthrough in this chapter 1 1 System requirements Revision Analyser will run on any modern PC with Windows 7 or Vista installed You will need to have version 4 0 installed of the Microsoft NET Framework Some project types also require the Java Runtime Environment to be installed You may however decide to not install these project types 1 2 Installation walkthrough We will now go through the installation process step by step The setup will give an error when NET Framework 4 0 is not installed so make sure to have it installed before
8. elte 5 johan 10 2010 18 30 18 Lognfx Tl 6 johan 6 10 2010 13 10 41 added Divan and Netwonsoft Json libraries Fl 7 johan 6 10 2010 13 12 02 added references to libraries la 8 johan 6 10 2010 14 52 45 rl 9 Mark 6 10 2010 21 45 51 Sensorinterface Atmel software Fl 10 Mark 6 10 2010 23 12 39 Added LEDs support Fl 11 johan 7 10 2010 14 08 32 Divan wordt nu nog gebruikt Figure 17 Overview of the selected revisions 2 2 2 Deleting revisions If for some reason you would like to delete a revision you can do this in the Manage SVN Revisions dialog Figure 17 Revisions that you added for analysis in the previous paragraph are noted with a green plus sign in front of them You can delete these revisions right away by selecting them and pressing the Delete button Revisions that were already analysed before can also be deleted the same way but will get a red minus sign in front of them You can also revert this by pressing Undelete Press OK to apply the changes Manage SVN Revisions Author Date Message 4 10 2010 19 00 58 Mark 6 10 2010 23 12 39 Added LEDs support johan 11 10 2010 12 57 48 nieuwste versie johan 13 10 2010 13 19 23 johan 17 10 2010 20 39 26 johan 19 10 2010 10 46 09 johan 19 10 2010 12 54 39 Mark 25 10 2010 12 20 37 AddSensor 26 10 2010 10 46 02 johan 26 10 2010 23 37 54 minimize widget works johan 5 10 2010 18 30 18 Login fix johan 6 10 2010 13 12 02 added references to libraries johan 6
9. igured Please enter a value for it below Name SOLIDSX_PATH Value C SolidsX bin Figure 9 Global Variable dialog If for some reason SolidSX2 does not start you might want to check the licensing information for this application Close Revision Analyser and start SolidSX2 manually via Start gt Applications gt SolidSource gt SolidSX gt SolidSX You will get to see the License wizard Figure 10 Here you can buy a license for SolidSX or request a 30 day trial license After you registered a valid license file you can restart Revision Analyser and continue with this guide License wizard ic Choose license Solids X Explore your code A license is required to use Solid Software eXplorer What do you Rw want to do I want to try Solid Software explorer I am going to use Solid Software ex plo rer For the First time and I want to use my 30 day trial period requires an internet connection I want to request another 30 day trial period Please enter your e mail address and a new license will be sent to WOL L Buy a license on our website T wul K L ian nn E ed solidsou ree s 6 I want to use a network license server 6 I already have a User license Figure 10 SolidSX2 License wizard Version 1 0 Page 8 of 14 Revision Analyser User Manual A Recorder project will show its own settings dialog after you create a project of this type Figure 11 In this dialog you can configure the UR
10. nalysis Sourcerer Plugin Project type for the open source project Sourcerer Current selection requires at least 22 4 MB of disk space Figure 3 Select Components dialog The Select components screen Figure 3 allows you to select the components you would like to install Please note that the SolidSX2 component can only be selected when it is not yet installed on your computer The Recorder Plugin component is only visible when you have the Java Runtime Environment installed on your computer Press Next to continue after you made your selection Version 1 0 Page 4 of 14 Revision Analyser User Manual me d _ Select Start Menu Folder Where should Setup place the program s shortcuts k Setup will create the programs shortcuts in the following Start Menu folder To continue dick Next If you would like to select a different folder cick Browse revision Analyser Don t create a Start Menu folder Figure 4 Select Start Menu Folder dialog In the Select Start Menu folder dialog Figure 4 you can select the folder in which you want the start menu icons to be placed If you do not want these icons to be created you can check the Don t create a Start Menu folder box Press Next to continue i Setup Revision Analyser Select Additional Tasks Which additional tasks should be performed Select the additional tasks you would like Setup to perform while installing Revision Analyser then dick Next
11. ns menu item or by pressing Ctrl M Manage SVN Revisions 8 Date Message 4 10 2010 19 00 58 6 10 2010 23 12 39 Added LEDs support 11 10 2010 12 57 48 nieuwste versie 12 10 2010 13 19 23 17 10 2010 20 39 26 19 10 2010 10 46 09 19 10 2010 12 54 39 25 10 2010 12 20 37 AddSensor 26 10 2010 10 46 02 26 10 2010 23 37 54 minimize widget works SESESESB S Figure 13 Manage SVN Revisions dialog 2 2 1 Adding revisions We will start off by adding revisions to the project Press the Add button in the Manage SVN revisions dialog This will open the Add SVN Revision s dialog Figure 14 Add SVN Revision s Search Revisions From 4 10 2010 jv To 7 12 2010 vr Limit Revision Author Date Message Figure 14 Add SVN Revision s dialog Version 1 0 Page 10 of 14 Revision Analyser User Manual In this dialog we can search for revisions on the SVN server You can select a date range and press Search to show revisions that were committed within that range You might want to limit the search results to a maximum of 100 or more to speed up the process You can also search using multiple date ranges by pressing the Advanced button This will open the Advanced Search dialog Figure 15 Advanced Search You can add multiple date ranges to your search query below From 13 10 2010 Bl To 16 10 2010 Hr Start Date End Date 4 10 2010 8 10 2010 13 10 2010 16 1
12. ould have a good understanding of how the application works 2 1 Creating a new project We will start of by creating a new Revision Analyser project After you started Revision Analyser click on File gt New Project or press Ctrl N to create a new project Figure 7 New Project CN cH Open Project Ctrl 0 Close Project Exit Figure 7 New Project menu This will show the New Project dialog Figure 8 For this guide we will create a Recoder project There might be other project types available as well such as Sourcerer Type in a name for your project select a location where the project files should be stored this will be automatically filled in by Revision Analyser and press OK to create the project FR Sourcerer Recoder is a Java framework for source code metaprogramming aimed to deliver a sophisticated infrastructure for many kinds of Java analysis and transformation tools RecoderProject C Users Johan Documents Revision Analyser RecoderProject Figure 8 New Project dialog Version 1 0 Page 7 of 14 Revision Analyser User Manual The first time you create a project in Revision Analyser you will get to see the Global Variable screen shown in Figure 9 It will ask you for the location of the SolidSX2 executable Revision Analyser will try to automatically find the correct path for you which is usually C SolidSX bin Press OK to continue The global variable SOLIDSX_PATH is not yet conf
13. ure Sensor ViewArchitecture log Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Wisio Add C Users Johan Pocuments Revision Analyser RecoderProject SVN Architecture Wisio Multi Tier Architecture pdf Add C Users Johan Documents Revision Analyser RecoderProject SVN Architecture Wisio DemoWeb pdf E Automatically dose this dialog after the tasks have been processed Figure 18 Task Log dialog 2 3 Using the revision timeline After you have added one or more revisions to the project you can start using the revision timeline The revision timeline shown in Figure 19 allows you to easily select a revision that you want to show in the SolidSX2 component You can do this by simply clicking near the revision that you want to show The application will automatically select the revision that is the nearest to your mouse click Figure 19 Revision timeline Version 1 0 Page 13 of 14 Revision Analyser User Manual 3 Other functionalities This chapter discusses functionalities that do not fit within the other chapters 3 1 Application settings The Tools gt Options menu item in Revision Analyser will open the Options dialog see Figure 20 Here you can add edit or delete global variables used across project types For example if you move SolidSX2 to another location you will have to change the global variable for this JAVA_PATH C Windows system32 SOLIDSX_ PATH C SolidSX bin
Download Pdf Manuals
Related Search