diff --git a/man/images/gui-newproject-addons.png b/man/images/gui-newproject-addons.png new file mode 100644 index 000000000..e2d368b93 Binary files /dev/null and b/man/images/gui-newproject-addons.png differ diff --git a/man/images/gui-newproject-pathsanddefines.png b/man/images/gui-newproject-pathsanddefines.png new file mode 100644 index 000000000..7aba59063 Binary files /dev/null and b/man/images/gui-newproject-pathsanddefines.png differ diff --git a/man/images/gui-newproject-project.png b/man/images/gui-newproject-project.png new file mode 100644 index 000000000..5a921a3a1 Binary files /dev/null and b/man/images/gui-newproject-project.png differ diff --git a/man/images/gui-newproject.png b/man/images/gui-newproject.png new file mode 100644 index 000000000..5f8243385 Binary files /dev/null and b/man/images/gui-newproject.png differ diff --git a/man/images/gui-results.png b/man/images/gui-results.png new file mode 100644 index 000000000..c24c8064c Binary files /dev/null and b/man/images/gui-results.png differ diff --git a/man/manual.docbook b/man/manual.docbook index e28688362..8771463a4 100644 --- a/man/manual.docbook +++ b/man/manual.docbook @@ -5,7 +5,7 @@ Cppcheck 1.81 dev - 2017-03-14 + 2017-08-12 @@ -47,7 +47,98 @@ - Getting started + Getting started (GUI) + + Start the GUI. + +
+ New Project + + It is not required but creating a new project file is a good first + step. You do so through File and New project + file. +
+ +
+ New Project - Paths and Defines + + What kind of project do you have? If it is a Visual Studio project + or if you can generate a compile database (cmake/qbs/etc), then you can + import the project. + + Otherwise you can configure the paths and defines manually. In + this screenshot below, a Visual Studio project file is imported: + + + + + + +
+ +
+ New Project - Project + + In the Project tab it is highly recommended that a + Cppcheck build dir is configured. This will be used + by Cppcheck to store various analysis information. It gives you whole + program analysis, incremental analysis, statistics, etc. Each project + should have its own unique build dir. In the screenshot below the build + dir is configured as cppcheck-build-dir. The path is + relative to the project file. + + You should also choose all the libraries that you use. In the + screenshot below the microsoft_sal and windows libraries are selected. + You can read more about libraries in this manual. + + + + + + +
+ +
+ New Project - Addons + + We skip the Exclude and + Suppressions tabs now, they can be used later to + tweak the results. + + In the Addons tab you can add extra analysis. The addons require + python. + + + + + + +
+ +
+ Analyze + + Click the OK button in the dialog. Analysis + will start immediately. + + + + + + + + All warnings are activated and therefore it is pretty noisy. There + are likely various warnings that you don't care about. You can fix that + easily, right click on messages and choose Hide or + Suppress. Hiding messages is not permanent, they will + be shown after next analysis. Suppressing messages is permanent, + suppressed ids are stored in the project file and those will not be + shown again. +
+ + + + Getting started (command line)
First test @@ -127,14 +218,14 @@ Checking path/file2.cpp... class="directory">src/c are checked: cppcheck -isrc/c src - - This option does not currently work with the - --project option and is only - valid when supplying an input directory.To ignore multiple directories - supply the -i multiple times. - The following command ignores both the src/b and src/c directories. - - cppcheck -isrc/b -isrc/c + + This option does not currently work with the --project option and is only valid when + supplying an input directory.To ignore multiple directories supply the + -i multiple times. The following + command ignores both the src/b and src/c directories. + + cppcheck -isrc/b -isrc/c
@@ -918,10 +1009,11 @@ Checking pen1.c... The arguments a function takes can be specified by <arg> tags. Each of them takes the number of the argument (starting from 1) in the nr attribute, - nr="any" for arbitrary arguments, or nr="variadic" for variadic arguments. - Optional arguments can be specified by providing a default value: - default="value". The specifications for individual arguments override - this setting. + nr="any" for arbitrary arguments, or + nr="variadic" for variadic arguments. Optional + arguments can be specified by providing a default value: + default="value". The specifications for individual + arguments override this setting.
Not bool