Quick Start Guide Visual Studio

8/3/2019 Quick Start Guide Visual Studio

http://slidepdf.com/reader/full/quick-start-guide-visual-studio 1/9

© 2008-2011 NICTA

QUICK START GUIDE – VERSION 2.6

VS 2005/2008/2010 EDITION



© 2008-2011 NICTA

Copyright © 2008-2011 National ICT Australia Limited(“NICTA”)

All rights reserved.

This document, as well as the software described in it, is providedunder license and may only be used or copied in accordance withthe terms of such license. The information contained herein is theproperty of NICTA and is made available under license to RedLizard Software. It is confidential information as between theRecipient and Red Lizard Software and remains the exclusiveproperty of NICTA. No part of this documentation may be copied,translated, stored in a retrieval system, or transmitted in any form or by any means, electronic, mechanical, photocopying, recording or otherwise without the prior written permission of NICTA.

NICTA does not warrant that this document is error-free.

Australian Technology ParkLevel 5, 13 Garden Street

Eveleigh NSW 2015Australia

http://www.redlizards.com

Support: [email protected]



© 2008-2011 NICTA

INTRODUCTION

Only a few simple steps are required to get Goanna Studio running on your local machine.This document will guide you through the process of installing Goanna. This distribution ofGoanna Studio 2010 runs on Windows (32-bit/64-bit, XP/Vista/7) and supports all editions ofVisual Studio 2005, 2008 and 2010 except for Visual Studio Express.

INSTALLATION

Quick solution: Double Click the installer .msi file and the setup will guide youthrough the rest.

For the installation of Goanna Studio follow the next few steps:

1. Download the Goanna distribution. The package is typically namedGoannaVS-X.msi , where X is the release number.

2. Double-Click the downloaded

.msi file, read and confirm thelicense.



© 2008-2011 NICTA

3. Follow the installation wizard.Goanna Studio will call VisualStudio to complete theintegration. This can takeseveral minutes .

4. At the end of the installationprocess click Finish .

5. Launch Visual Studio.

USING GOANNA

Quick solution: You can run Goanna Studio on selected files, a project or asolution by clicking the Goanna button in the tool bar.

Goanna Studio can be invoked on a project or a solution by selecting the appropriate entry

from the Goanna menu, where the Goanna icon appears.



© 2008-2011 NICTA

You can also selectseveral files andright-click on these.The Goanna optionin the context menuallows you to run thetool over theselected files only.This also works for aproject or a solution.

Goanna acts like the standardcompiler and reports bugs in asimilar fashion to a compiler.The warnings will appear in theWarnings tab. Double-clicking awarning message will place thecursor at the offending part of the code.

Goanna Studio allows you tosuppress warnings that youwant to ignore.

To hide a warning, right-clickit in the Warnings tab, andselect Suppress Warning from the context menu.

Click the Show Suppressed

Warnings button on thetoolbar to toggle the Warnings list between the shown and hidden warnings. From there, youcan unsuppress warnings in the same way.



© 2008-2011 NICTA

You can display a tracebelonging to a warningby right-clicking on thatwarning and selectingShow Trace from thecontext menu. Theresulting Goanna Trace popup window will letyou step through thesource code, which mayhelp you debug larger functions.

EXPORTING WARNINGS

Quick solution: Select Goanna Summary from the Tools menu, and click theExport button to export the Goanna warnings for the project in CSV format.

The Goanna Summarywindow allows you toorganize Goanna’s warningmessages, and export them.To open it, select GoannaSummary from the Goanna menu.

You can expand the drop-down lists to view theproject’s warnings by file or

check name.

To export the warnings, clickthe Export button. This willallow you to save thewarnings in CSV (CommaSeparated Value) format.



© 2008-2011 NICTA

LICENSE PURCHASE & ACTIVATION

Quick solution: In the Goanna menu, click on Activate Goanna. You canactivate a license either by entering your username and password used for purchase or going to http://www.redlizards.com/activate.html .

PURCHASE

To purchase licenses visit: http://www.redlizards.com/purchase.html

ACTIVATION

Once you purchase one or multiple licenses you will receive an email with the details of your purchase, including the order number. This gives you the right to activate a matchingnumber of seats.

For each seat you can activate the license by:

• entering your username/password used for purchase, or

• going to http://www.redlizards.com/activate.html and follow the instructions to obtainan individual license file, and upload it using the Install button, or

• typing the address of your network license server into the Host box, after checkingthe Use network license option.



© 2008-2011 NICTA

CHECKS & OPTIONS

Quick solution: Right-click on a project or a solution in the Solution Explorer,select Goanna Settings , and select the checks for Goanna.

To configure and select the checks that Goanna Studio performs in each run, right-click on aproject or a solution in the Solution Explorer, or go to the Visual Studio Goanna menu andselect Goanna Settings . The popup window will display the descriptions of the checksGoanna Studio offers and a number of options.

CHECKS

A check is enabled by selecting its check box. Not all checks might be switched on bydefault.

The full description of the checks with example programs can be found in the Goanna StudioUser Guide .

Typically, your checks are set solution-wide. However, it is possible to change settings for aproject only by checking Override solution in the Goanna settings window. Make sure touncheck it once a project should use the same checks as a solution again.

OPTIONS

You can tweak the following options to define some of Goanna Studio’s runtime behavior:

• Interprocedural analysis: This enables whole-program analysis, enhancing the precision of many checks. However, this will result inadditional computational overhead, and somecomplex programs may require more than oneanalysis run to analyze completely.

• Analyze globals : Instructs Goanna to includeglobal variables in its analysis.

• Verbose console output: This gives additionalruntime information in the console .

• Timeout: This is a per-file time-out in seconds.Goanna will run for <seconds> seconds andterminate with the issues found until then.

• Analyze user headers: Indicates that Goanna

should analyze C and C++ header files whosenames are given in double-quotes. Header files



© 2008-2011 NICTA

whose names are given in angle brackets are not analyzed.

• Additional arguments: This allows you to pass arguments to the Goanna executable.More information is available in the Goanna Studio User Guide .

Documents

Quick Start Guide Visual Studio