klocwork操作步骤.doc

Klocwork操作步骤一、启动Klocwork：1. Klocwork包括Server Build版本和User Desktop版本，可根据实际情况安装。安装可以按照默认目录安装，也可以创建三个新的路径，如C:KW0server、C:KW0pr和C:KW0client，分别安装Server版，指定工程路径和User版，以方便命令行操作。2. Klocwork在使用时，将license文件放在project_root工程路径下license目录。要启动所有的Klocwork服务，进入命令行操作，使用下面的命令kwservice start 如果用户有多个projects_root目录，且共用一个license文件时，需要将license文件复制到其他的projects_root目录的license路径中。每次只能启动一个工程目录。Klocwork启动成功，如下图：关于kwservice命令的其他选项可以通过直接输入kwservice获得。也可以编写批处理文件，简化操作。二、Klocwork指定编译器配置文件Klocwork能够分析C，C+，C#和Java代码。准确的构建信息和客户代码是代码分析系统的两个输入。接下来，我们就将介绍下与编译器构建相关的配置文件：u _filter.xmlu kwcc_config.xmlu kwfilter.conf_filter.xml编译器配置文件是在用kwinject命令进行构建说明时使用的指定编译器配置文件，用来确定采用哪种编译方式。文件名称为_filter.xml。创建一个定制编译器配置文件：首先对在/config 中的现有配置文件做一个备份. 使其按照下面的格式进行命名： _filter.xml, 其中 是编译器的名称，并将它保存在下面的路径下：/config_filter.xml文件中包含着相关编译器类型的的编译选项。kwcc_config.xml指定编译器路径，系统头文件路径和宏定义选项。详细内容见第四部分，在Tornado2.2中使用Klocworkkwcc_config.xml指定在本机上采用的具体编译器。已有的语言扩展已包括gnu (GCC), ms (Visual Studio)，arm (ARMCC), std (标准 C/C+); 缺省即是std。kwfilter.conf/config下的kwfilter.conf文件，负责编译器名称与编译器选项配对。kwfilter.conf文件中，将同属一种编译器类型的语言扩展采用过滤器的方式配准起来，下面是kwfilter.conf文件中的一段，针对GNU C/C+编译器的：# Default GNU C/C+ compilerfiltergnugcc, g+, cc, c+,ccsimpc【语法：filter 编译器名称1, 编译器名称2,】这样，当进入klocwork对客户代码的构建阶段，系统会通过编译器名称获取相关的构建信息，使Klocwork工具能够按照其标准的系统构建的方式来分析整个软件系统。三、在MSVC中使用klocwork因为MS系列编译器是klocwork默认支持的编译器，所以不用编辑修改编译器配置文件。MSVC6.0安装klocwork之后，用户可以“工具”菜单的“定制”窗口打开MSVC6.0与klocwork的集成插件。如下图：打开已有的工程，选中一个项目，点击klocwork工具栏中的“Check Active Project”，对工程中的文件进行分析。从调试窗口中找到Macro窗口，如下图，可以得到分析结果，还能够了解klocwork进行代码分析时的过程。分析得到的issues报告可以链接到代码行中。点击klocwork工具栏中的“show issues filter window”查看报告。该窗口可以根据用户需要显示每条issues的详细内容，以及问题报告。选择Filter按钮，用户可以通过Filter窗口选择issues集的状态，按照严重程度选择issues集合。选择Change status按钮，用户可以根据当前代码问题修改状态通过Change status窗口选择被选issues的状态（分析、修复、忽略、不是一个问题等）。要查看更详细的报告需要通过Klocwork Review，但是需要先在Klocwork Management Console中通过导入MSVC工程文件的方式建立新工程。具体方法见第五节“创建新工程”。用户可以在Klocwork review的工程列表中选择经过Klocwork构建的工程。Visual Studio 2005安装klocwork后，用户可以“工具”菜单的“自定制”窗口打开Visual Studio 2005与klocwork的集成插件。如下图：用法和VC6.0相似。支持C、C+、C#程序的普通项目应用，但目前klocwork不支持Visual Studio 2005 C#网站类型项目的应用。四、在Tornado2.2中使用klocwork创建一个downloadable的C工程，采用ccsimpc编译器。确保已经编译成功。采用Tornado2.2系列编译器需要先做配置，因其不在klocwork默认的编译器列表中。我们需要做一些配置工作，简单过程如下：从/config目录中选择kwcc_config.xml，在其中添加下面的代码： 从/config目录中选择kwfilter.conf，修改# Default GNU C/C+ compiler段下的代码，如下：# Default GNU C/C+ compilerfiltergnugcc, g+, cc, c+, ccsimpc这样就可以保证klocwork在应用ccsimpc编译器进行代码分析时，可以采用GNU C/C+编译器的编译选项进行分析。因为Tornado的工程有自己的makefile，使用kwinject指令可以在makefile的指导下产生构建说明文件kwinject.out.。使用“kwinject make”采用目录下的makefile产生kwinject.out文件。Kwinject.out文件包含完整的编译信息。接下来在Klocwork Management Console中创建一个新工程，用产生的kwinject.out构建说明作为输入。五、创建新工程新工程的输入可以有三种：u 构建说明文件u Visual studio工程、解决方案或者工作空间u TablesTables是一个目录，该目录通常是一个临时构建目录，存储构建时保存的数据。接下来，我们使用上一节生成的构建说明文件Kwinject.out创建一个新工程。对于其他输入的工程建立来说，过程大致相同，不同的是在选择分析源的步骤上。1. 打开Klocwork Management Console，New Project。输入名字，程序使用的语言。语言选项可以多选。然后点击“Next”。2. 选择Build from Build Specification Files，使用Add按钮添加生成的kwinject.out文件。然后点击“Next”。注：如果输入是MSVC的工程文件dsp、解决方案plj或者工作空间dsw，则点击“Build from a Visual Studio Project,Solution or Workspace”，导入相关文件。3.选择报告选项。然后点击“Finish”。4.创建完成后，在项目名上右键点击“Build”。选择klocwork tables目录。5.从Details和Status窗口可以查看构建的细节和状态。6. 构建成功之后，使用Klocwork Review查看报告。http:/localhost:8072六、在Eclipse中使用klocworkKlocwork支持Eclipse3.4以上版本。从帮助菜单选取“软件升级”，在“可用软件”的窗口中选“安装”，选择C:KW0clientupdate-sitekw-kc-eclipse-update-site.zip进行安装解压缩。1. 访问工作空间设置 (Window Pre