Skip to content

Commit f227dcd

Browse files
committed
Updated readme.md
1 parent 70c2b7c commit f227dcd

File tree

1 file changed

+17
-36
lines changed

1 file changed

+17
-36
lines changed

readme.md

Lines changed: 17 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,35 @@
1-
# About
1+
# CodeChecker Eclipse Plugin
22

33
[![Build Status](https://travis-ci.org/Ericsson/CodeCheckerEclipsePlugin.svg?branch=master)](https://travis-ci.org/Ericsson/CodeCheckerEclipsePlugin)
4-
This is a C/C++ code analysis plugin for Eclipse that shows bugs detected by the [Clang Static Analyzer](http://clang-analyzer.llvm.org/) and [Clang Tidy](http://clang.llvm.org/extra/clang-tidy/) analyzers.
54

6-
# Requirements
5+
This is a C/C++ code analysis plugin for Eclipse that shows bugs detected by the [Clang Static Analyzer](http://clang-analyzer.llvm.org/) and [Clang Tidy](http://clang.llvm.org/extra/clang-tidy/) analyzers, using [CodeChecker](https://github.com/Ericsson/codechecker) as a backend,
6+
7+
## Requirements
78

89
* Linux operating system
910
* Recent [CodeChecker](https://github.com/Ericsson/codechecker)
10-
* Clang 3.6
1111
* [Eclipse](www.eclipse.org): the plugin is currently tested with Eclipse Neon, but any recent Eclipse version should work
1212
* Eclipse CDT
1313
* Java 1.7
14-
~~* [Thrift](https://thrift.apache.org/) 0.9.1 or later
15-
16-
### Install or build Thrift 0.9.1
17-
##### install:
18-
using a package manager provided by your OS:
19-
Ubuntu:
20-
```sudo apt-get install -y thrift-compiler```~~
21-
22-
##### build from source:
23-
~~~~~~~~.sh
24-
curl http://archive.apache.org/dist/thrift/0.9.1/thrift-0.9.1.tar.gz | tar zx
25-
cd thrift-0.9.1
26-
./configure
27-
make
28-
# add `compiler/cpp/` to PATH where the thrift binary is available
29-
export PATH=$PATH:$PWD/compiler/cpp/
30-
~~~~~~~~
3114

15+
## Build and install CodeChecker Eclipse Plugin
16+
### Build
17+
run `mvn package` in the project's directory in:
3218

19+
`./eclipse-plugin/`
3320

34-
# Build and install CodeChecker Eclipse Plugin
35-
## Build
36-
* run `mvn package` in the project's directory
37-
38-
## Install
39-
* Copy the `cc.codechecker.eclipse.plugin-0.0.1-SNAPSHOT.jar`:
21+
### Install
22+
* Copy the `cc.codechecker.eclipse.plugin-0.0.6-SNAPSHOT.jar`:
4023
* From: ./eclipse-plugin/eclipse/cc.codechecker.eclipse.plugin/target/
4124
* To: the dropins directory of Eclipse
4225

43-
# How to use
26+
## How to use
4427
Make sure that before staring Eclipse:
4528

4629
* CodeChecker/bin directory is included in PATH (e.g.: `export PATH="/home/<username>/CodeChecker/bin/:$PATH"`)
4730
* Python virtualenv with CodeChecker dependencies is sourced (e.g.: `source /home/<username>/venv/bin/activate`)
4831

49-
__Currently the plugin is usable with a CDT project.__
32+
__Currently the plugin is only usable with a CDT project.__
5033

5134
#### 1. Setup Perspective
5235
In Eclipse, select Window, Perspectives, and activate the CodeChecker perspective.
@@ -55,12 +38,12 @@ Alternatively, you can manually add the two windows under the CodeChecker catego
5538
![Window->Perspective->Open Perspective->Other](docs/allperspective.png)
5639

5740
#### 2. Setup Nature
58-
The plugin is activated on a per project basis, first you have to add the CodeChecker Nature to a CDT project using it's context menu in the project explorer.
41+
The plugin is activated on a per project basis, first you have to add the __CodeChecker Nature__ to a CDT project using the projects context menu in the project explorer with `Add CodeChecker Nature` command.
5942

6043
![CodeChecker Nature Add](docs/nature.png)
6144

6245
#### 3. Configure CodeChecker and checkers
63-
After that, the settings can be customized in the project preferences window under the CodeChecker panel. For the plugin to work correctly, it is mandatory to add the correct path to the root of the CodeChecker package. You can download CodeChecker from [here](https://github.com/Ericsson/codechecker).
46+
After that, the settings can be customized in the project preferences window under the CodeChecker panel. For the plugin to work correctly, it is mandatory to add the correct path to the root of the CodeChecker package. You can download and compile CodeChecker from [here](https://github.com/Ericsson/codechecker).
6447

6548
![CodeChecker Configure](docs/config.png)
6649
![CodeChecker Checkers Configure](docs/checkershow.png)
@@ -69,19 +52,17 @@ After the plugin is successfully configured for a project, it'll listen to build
6952

7053
#### 4. Set up eclipse C/C++ build environment
7154

72-
The runs only if your project can be built by Eclipse (as it intercepts gcc build commands).
55+
The code analysis runs only if your project can be built by Eclipse (as it intercepts gcc build commands).
7356
Please check that your builder is set up correctly in properties/C/C++ Build settings.
7457
If all goes well, you should be able to build your project from Eclipse using the Project/Build Project menu item.
7558

7659
#### 5. Analyze C/C++ project and view results
77-
By default it displays the problems related to the currently selected file on the problems view, and the details for a selected bugpath in the Details view. Selecting a problem or jumping to a details item is possible with double clicking on it.
60+
By default the plugin displays the problems related to the currently selected file on the current file reports view. Here the viewer can decide to check the individual reports selected from the reports tree, and view the related bugpath. Double clicking on a bugpath item will jump and set the cursor to that line in the editor.
7861

7962
*Please note that codechecker will only show analysis results for files that you built. This means that if you want to see all bugs for your project you will need to do a full (clean) build. After you update a source file, analysis results will be updated when you rebuild your project.*
8063

81-
The problems view can be customized: it supports custom search options with a filter editor, where saving or loading filters is also possible.
82-
8364
![CodeChecker Runtime Example](docs/example.png)
8465

85-
## Troubleshooting and Development
66+
## Contributing
8667

8768
For further information see [developer documentation](docs/developer.md).

0 commit comments

Comments
 (0)