Skip to content

Commit 169f6ae

Browse files
authored
Fix #15136 (gui: rewrite the online help) (#8959)
Extend the GUI help with detailed explanations and new screenshots: - rewrite the existing pages and describe every option in the project file dialog and the preferences - add pages for the main window, suppressions, results files/printing/ statistics, scratchpad/library editor, command line options and troubleshooting - add a shared stylesheet, a contents tree and index keywords - replace the old screenshots with new ones of the current GUI - remove the obsolete manual.html (Cppcheck 1.46)
1 parent 0515ce2 commit 169f6ae

56 files changed

Lines changed: 2451 additions & 1224 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎gui/help/commandline.html‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
<html>
2+
<head>
3+
<title>Command line options</title>
4+
<link rel="stylesheet" type="text/css" href="style.css">
5+
</head>
6+
<body>
7+
8+
<h1>Command line options</h1>
9+
10+
<p>The GUI can be started from a terminal or a shortcut with options:</p>
11+
12+
<pre>cppcheck-gui [OPTIONS] [files or paths]</pre>
13+
14+
<table class="options" border="1" cellspacing="0" cellpadding="4" width="100%">
15+
<tr><th>Option</th><th>Description</th></tr>
16+
<tr><td><code>-p &lt;file&gt;</code></td><td>Open the project file and analyze
17+
it. If the project has a build dir with earlier results, these are shown
18+
instead; click <i>Reanalyze all files</i> to analyze again.</td></tr>
19+
<tr><td><code>-l &lt;file&gt;</code></td><td>Open a results file in XML
20+
format.</td></tr>
21+
<tr><td><code>-d &lt;directory&gt;</code></td><td>Used with <code>-l</code>:
22+
the folder that was analyzed to create the results file. Relative paths in
23+
the results file are relative to this folder. It is needed to show the
24+
source code of the warnings.</td></tr>
25+
<tr><td><code>-h</code>, <code>--help</code></td><td>Show a short description
26+
of the options.</td></tr>
27+
<tr><td><code>-v</code>, <code>--version</code></td><td>Show the version of
28+
the GUI.</td></tr>
29+
<tr><td><code>--data-dir=&lt;directory&gt;</code></td><td>Meant for
30+
installation scripts. Stores the folder where Cppcheck's data files
31+
(translations, library configurations, platforms, addons) are installed.
32+
The GUI is not started when this option is used.</td></tr>
33+
<tr><td><i>files or paths</i></td><td>Analyze these files and folders without
34+
a project. If one of the arguments is a project file
35+
(<code>*.cppcheck</code>), it is opened as with <code>-p</code>. If one of
36+
them is an XML file, it is opened as a results file.</td></tr>
37+
</table>
38+
39+
<h2>Examples</h2>
40+
41+
<p>Open a project:</p>
42+
<pre>cppcheck-gui -p myproject.cppcheck</pre>
43+
<p>or simply:</p>
44+
<pre>cppcheck-gui myproject.cppcheck</pre>
45+
46+
<p>Look at the results of a CI job. The job ran Cppcheck in the folder
47+
<code>/home/me/src/myproject</code> and saved the results:</p>
48+
<pre>cppcheck-gui -l results.xml -d /home/me/src/myproject</pre>
49+
50+
<p>Analyze a folder without a project:</p>
51+
<pre>cppcheck-gui src/</pre>
52+
53+
<h2>Starting without options</h2>
54+
55+
<p>When the GUI is started without options, it opens the project that was open
56+
when it was closed last time, and shows the results of the last analysis if
57+
the project has a build dir.</p>
58+
59+
<p class="nav">Previous: <a href="preferences.html">Preferences</a> |
60+
Next: <a href="troubleshooting.html">Troubleshooting</a></p>
61+
62+
</body>
63+
</html>
15.6 KB
15.5 KB

‎gui/help/images/context-menu.png‎

25.4 KB
-196 KB
Binary file not shown.

‎gui/help/images/library-editor.png‎

15.3 KB

‎gui/help/images/main-window.png‎

51.7 KB

‎gui/help/images/menu-analyze.png‎

12 KB

‎gui/help/images/menu-edit.png‎

3.06 KB

‎gui/help/images/menu-file.png‎

7.23 KB

0 commit comments

Comments
 (0)